Project

General

Profile

Misc #13813

Ripper documentation for RDoc is broken

Added by aycabta (aycabta .) about 2 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
[ruby-core:82376]

Description

In ext/ripper/lib/ripper.rb, license section of documentation for RDoc below:

# == License
#
#   Ruby License.
#
#                                                 Minero Aoki
#                                         aamine@loveruby.net
#                                       http://i.loveruby.net

This is indented, and indented documentation is treated as Ruby code.
So this becomes strange documentation, it's highlighted as some Ruby tokens.

The screenshot below is rendered HTML of Ripper documentation on ruby-doc.org:

e-mail and URL as Ruby code

I think this should be fixed to correct documentation.
The patch what I attached on this issue fixes it like below:

# == License
#
# Ruby License.
#
# - Minero Aoki
# - aamine@loveruby.net
# - http://i.loveruby.net

Files

ripper-license-in-document.patch (544 Bytes) ripper-license-in-document.patch aycabta (aycabta .), 08/14/2017 03:25 PM

Associated revisions

Revision 9028340d
Added by nobu (Nobuyoshi Nakada) about 2 years ago

ripper.rb: fix License format [ci skip]

  • ext/ripper/lib/ripper.rb: [DOC] fix format of the License description and the author. patched by aycabta (Code Ahss) at [ruby-core:82376]. [Bug #13813]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59597 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 59597
Added by nobu (Nobuyoshi Nakada) about 2 years ago

ripper.rb: fix License format [ci skip]

  • ext/ripper/lib/ripper.rb: [DOC] fix format of the License description and the author. patched by aycabta (Code Ahss) at [ruby-core:82376]. [Bug #13813]

Revision 59597
Added by nobu (Nobuyoshi Nakada) about 2 years ago

ripper.rb: fix License format [ci skip]

  • ext/ripper/lib/ripper.rb: [DOC] fix format of the License description and the author. patched by aycabta (Code Ahss) at [ruby-core:82376]. [Bug #13813]

Revision 59597
Added by nobu (Nobuyoshi Nakada) about 2 years ago

ripper.rb: fix License format [ci skip]

  • ext/ripper/lib/ripper.rb: [DOC] fix format of the License description and the author. patched by aycabta (Code Ahss) at [ruby-core:82376]. [Bug #13813]

History

#1

Updated by nobu (Nobuyoshi Nakada) about 2 years ago

  • Status changed from Open to Closed

Applied in changeset trunk|r59597.


ripper.rb: fix License format [ci skip]

  • ext/ripper/lib/ripper.rb: [DOC] fix format of the License description and the author. patched by aycabta (Code Ahss) at [ruby-core:82376]. [Bug #13813]

Also available in: Atom PDF