Skip to content

Simplify newline handling of comment token in TokenStream#to_html #1532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tompng merged 2 commits into from
Jan 1, 2026
+4 −8
Merged

Simplify newline handling of comment token in TokenStream#to_html #1532

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61f11a6
Simplify newline handling of comment token in TokenStream#to_html
tompng Dec 26, 2025
4d579e6
Merge branch 'master' into simplify_token_stream_nl
tompng Jan 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions lib/rdoc/token_stream.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,7 @@ def self.to_html(token_stream)
then 'ruby-identifier'
end

comment_with_nl = false
if :on_comment == t[:kind] or :on_embdoc == t[:kind] or :on_heredoc_end == t[:kind]
comment_with_nl = true if "\n" == t[:text][-1]
text = t[:text].rstrip
else
text = t[:text]
end
text = t[:text]

if :on_ident == t[:kind] && starting_title
starting_title = false
Expand All @@ -65,7 +59,9 @@ def self.to_html(token_stream)
text = CGI.escapeHTML text

if style then
"<span class=\"#{style}\">#{text}</span>#{"\n" if comment_with_nl}"
end_with_newline = text.end_with?("\n")
text = text.chomp if end_with_newline
"<span class=\"#{style}\">#{text}</span>#{"\n" if end_with_newline}"
else
text
end
Comment on lines 61 to 67
Copy link
Member

@st0012 st0012 Dec 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I think this is more expressive:

      if style
        if text.end_with?("\n")
          "<span class=\"#{style}\">#{text.chomp}</span>\n"
        else
          "<span class=\"#{style}\">#{text}</span>"
        end
      else
        text
      end

Expand Down
Loading