Project

General

Profile

Actions
Copy link

Misc #13813

closed

Ripper documentation for RDoc is broken

Added by aycabta (aycabta .) over 6 years ago. Updated over 6 years ago.

Status:
Closed
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
Actions
Copy link
 #1

Updated by nobu (Nobuyoshi Nakada) over 6 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]
Actions
Copy link

Also available in: Atom PDF

Like0
Like0