Bug #7405: Rdoc for CGI#header alias

• Status: Closed
• Priority: Normal
• Assignee: xibbar (Takeyuki FUJIOKA)
• Target version: 2.0.0
• ruby -v: ruby 2.0.0dev (2012-11-19 trunk 37712) [i686-linux]

[stomar (Marcus Stollsteimer)]

=begin
CGI#header was only reintroduced as alias for CGI#http_header for compatibility reasons (see #7286), it's use for this purpose is deprecated. This should be made clear in the rdoc (patch provided):

This method is an alias for #http_header, as long as the
HTML5 tag maker is not used.

NOTE: #header should no longer be used to create HTTP header
blocks, the alias is provided only for backwards compatibility.

With the HTML5 tag maker #header creates a <header> element.

=end

[zzak (Zachary Scott)]

=begin
I like to avoid negatives as much as possible.

(({This method is an alias for #http_header, when HTML5 tag maker is inactive.}))

(({NOTE: use CGI#http_header to create HTTP header blocks, this alias is only provided for backwards compatibility.}))

(({Using CGI#header with the HTML5 tag maker will create a element.}))
=end

[stomar (Marcus Stollsteimer)]

Much better, thank you.

[stomar (Marcus Stollsteimer)]

Will you commit your version?

[zzak (Zachary Scott)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

This issue was solved with changeset r37811.
Marcus, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• lib/cgi/core.rb: Documentation for CGI#header alias
  Based on a patch by Marcus Stollsteimer
  [ruby-core:49585] [Bug #7405]