- Notifications
You must be signed in to change notification settings - Fork486
markdown_ast include comment.kind in heading (for each node)#1111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:master
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
I'm not sure about this change - I'd welcome some input from other folks yay or nay. Essentially, I think it'd be preferable to represent things like
Instead of prepending the type to each item, which seems to introduce a lot of repetitive noise into Markdown documentation. |
It definitely depends on the personal preference. I'd like to see different kinds/types to be visually separated. However i agree that prepending the kind to each item can be "too much". Maybe you can work something (nice and clean) out in the future. |
Uh oh!
There was an error while loading.Please reload this page.
Markdown output won't include anything that clearly reveals the kind of a named item.
You have to analyse the output (by looking at the naming or at the displayed subheadings) to figure out if something is a class, a function, etc.
My proposal:
before:
after:
Works great for me. Next step could be adding a cli option to turn this on or off.
Feel free to change the code/proposal the way you like it. I don't mind how it is displayed as long as the kind is included in the output.
Unit-tests for this module must be adapted to this change.