Bug #7405

Rdoc for CGI#header alias

Added by Marcus Stollsteimer over 1 year ago. Updated over 1 year ago.

[ruby-core:49585]
Status:Closed
Priority:Normal
Assignee:Takeyuki FUJIOKA
Category:doc
Target version:2.0.0
ruby -v:ruby 2.0.0dev (2012-11-19 trunk 37712) [i686-linux] Backport:

Description

=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

rdoc_for_cgi_header_alias.patch Magnifier (624 Bytes) Marcus Stollsteimer, 11/20/2012 12:30 AM

Associated revisions

Revision 37811
Added by Zachary Scott over 1 year ago

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

History

#1 Updated by Zachary Scott over 1 year ago

=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

#2 Updated by Marcus Stollsteimer over 1 year ago

Much better, thank you.

#3 Updated by Marcus Stollsteimer over 1 year ago

Will you commit your version?

#4 Updated by Zachary Scott over 1 year ago

  • 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 [Bug #7405]

Also available in: Atom PDF