Add support for referencing flag types in documentation #12 #13
Conversation
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
Juneezee
requested changes
Aug 26, 2025
Member
Juneezee
left a comment
Juneezee
left a comment
There was a problem hiding this comment.
Thanks for the PR! I think you need to run go mod tidy to update go.sum
Juneezee
approved these changes
Aug 26, 2025
Contributor
|
Is this a user facing feature? How to test it with my projects? |
Author
|
To test it you just need to have a command that has at least one flag available and generate the docs for it using the tabular template. In the generated table the column for "type" should be available |
Contributor
|
I have no idea how to generate docs for |
Author
|
You just have to use ToTabularMarkdown function. Check examples in docs_test.go |
Author
|
Hey @dearchap, sorry to bother you but can you please review this PR? It is only 2 lines change and updated tests... |
dearchap
approved these changes
Sep 10, 2025
Member
Author
|
Hey @dearchap, kind reminder, can you please take care of the comment above? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Add support for referencing flag types in documentation #12