tools: make v doc -f md module output useful by default#24737
Merged
Conversation
|
Connected to Huly®: V_0.6-23113 |
Contributor
|
I wonder if it should include the readme as well? ... but perhaps it may be possible to just include the content of the readme in the output too, without any further conversion (like the HTML backend does). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR makes autogenerated markdown docs useful.
Before this PR
v doc -f md modulewithout-commentsproduces useless docs without function signatures, struct bodies, etc and actual docstrings. There is no-commentsflag needed anymore for getting normal docs.There is example before and after output.