markdown_ast include comment.kind in heading (for each node) #1111
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.