Summary
Several generated pages contain prose or examples that are being interpreted as markdown links when they should remain literal text or code.
The markdown is syntactically valid, but the rendered result is wrong and often produces broken local links.
Reproduction
- Run
rake vendor:setup.
- Run
rake vendor:docs:minitest and rake vendor:docs:rails.
- Open the generated files listed below.
- Inspect the rendered output and the emitted markdown around the examples.
Examples
vendor/docs/rails/ActionDispatch/Cookies.md:76
- Emits:
[www.example.com](www.example.com)
www.example.com should remain literal example text, not a relative local link.
vendor/docs/rails/ActionController/Renderers.md:29
- Emits:
[Mime](:csv)
Mime[:csv] should remain code/plain text, not a markdown link to :csv.
vendor/docs/minitest/Minitest/Runnable.md:35
- Emits:
[options](:include) and [options](:exclude)
:include and :exclude should not become link targets.
vendor/docs/rails/ActionView/Helpers/DateHelper.md:7
- Emits:
\b[irthday](month)
vendor/docs/rails/ActionView/Helpers/DateHelper.md:11
- Emits:
\d[ate](month)
- Both of those are visibly mangled words in the final markdown.
Actual Result
Bracket-like text in prose/examples is being converted into clickable markdown links or otherwise mangled text.
Expected Result
These cases should remain literal text or code spans unless there is a real documentation target.
Specifically:
- bare hostnames should not become relative local links,
Symbol examples like :csv, :include, and :exclude should not become links,- partial word fragments should not become links.
Summary
Several generated pages contain prose or examples that are being interpreted as markdown links when they should remain literal text or code.
The markdown is syntactically valid, but the rendered result is wrong and often produces broken local links.
Reproduction
rake vendor:setup.rake vendor:docs:minitestandrake vendor:docs:rails.Examples
vendor/docs/rails/ActionDispatch/Cookies.md:76[www.example.com](www.example.com)www.example.comshould remain literal example text, not a relative local link.vendor/docs/rails/ActionController/Renderers.md:29[Mime](:csv)Mime[:csv]should remain code/plain text, not a markdown link to:csv.vendor/docs/minitest/Minitest/Runnable.md:35[options](:include)and[options](:exclude):includeand:excludeshould not become link targets.vendor/docs/rails/ActionView/Helpers/DateHelper.md:7\b[irthday](month)vendor/docs/rails/ActionView/Helpers/DateHelper.md:11\d[ate](month)Actual Result
Bracket-like text in prose/examples is being converted into clickable markdown links or otherwise mangled text.
Expected Result
These cases should remain literal text or code spans unless there is a real documentation target.
Specifically:
Symbolexamples like:csv,:include, and:excludeshould not become links,