documentationjs / documentationjs/documentation

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

Open
#1,609 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

**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

* What version of documentation.js are you using?: 14.0.2
* How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):
Node.js API

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.