documentationjs / documentation

:book: documentation for modern JavaScript
http://documentation.js.org/
Other
5.78k stars 482 forks source link

[Markdown] Format our returns as heading to match the params. #1609

Open 10Derozan opened 12 months ago

10Derozan commented 12 months ago

If you're reporting a bug, please include input code, output documentation, a description of what you expected to happen, and what happened instead.

When the output is markdown, don't you think we should also format our returns as heading to match the params? https://github.com/documentationjs/documentation/blob/master/src/output/markdown_ast.js#L181 https://github.com/documentationjs/documentation/blob/master/src/output/markdown_ast.js#L111