mirror of
https://github.com/ruby/ruby.git
synced 2025-08-24 21:44:30 +02:00
d0c17cbd09
While writing some Markdown documentation for Rails, I came across an interesting case where trying to link to an instance method at the start of a line would instead parse as an H1 heading: ```markdown #response_body= ``` Expected: ```html <a href=""><code>#response_body=</code></a> ``` Actual: ```html <h1>response_body=</h1> ``` According to the CommonMark spec: > At least one space or tab is required between the # characters and the > heading’s contents, unless the heading is empty. Note that many > implementations currently do not require the space. However, the space > was required by the original ATX implementation, and it helps prevent > things like the following from being parsed as headings: > > Example 64 So while some implementations do not follow this requirement, I believe RDoc should because it makes it easy to write text similar to Example 64 (which was used in the new test) and it also enables automatically linking to instance methods at the start of a line. |
||
|---|---|---|
| .. | ||
| code_object | ||
| generator | ||
| i18n | ||
| markdown | ||
| markup | ||
| parser | ||
| rd | ||
| ri | ||
| stats | ||
| .document | ||
| code_object.rb | ||
| code_objects.rb | ||
| comment.rb | ||
| cross_reference.rb | ||
| encoding.rb | ||
| erb_partial.rb | ||
| erbio.rb | ||
| generator.rb | ||
| i18n.rb | ||
| known_classes.rb | ||
| markdown.rb | ||
| markup.rb | ||
| options.rb | ||
| parser.rb | ||
| rd.rb | ||
| rdoc.gemspec | ||
| rdoc.rb | ||
| ri.rb | ||
| rubygems_hook.rb | ||
| servlet.rb | ||
| stats.rb | ||
| store.rb | ||
| task.rb | ||
| text.rb | ||
| token_stream.rb | ||
| tom_doc.rb | ||
| version.rb | ||