rdoc icon indicating copy to clipboard operation
rdoc copied to clipboard

Section comments are not shown in HTML output

Open gettalong opened this issue 9 years ago • 1 comments

When commenting a section like

# :section: Some Section
# Some documentation for the section here

the section is created but the documentation is not shown in the HTML output.

You can actually see the problem in the RDoc documentation itself:

  • https://github.com/rdoc/rdoc/blob/master/lib/rdoc/markup/to_html.rb#L148 - definition of "Visitor" section with some documentation
  • http://docs.seattlerb.org/rdoc/RDoc/Markup/ToHtml.html#Visitor - Output with missing documentation

Thanks for this great tool!

gettalong avatar Mar 06 '15 08:03 gettalong

Still a bug >6 years later? If it's difficult to fix can it at least be documented that the section headers won't be output to HTML?

nevans avatar Nov 18 '21 15:11 nevans