-
Notifications
You must be signed in to change notification settings - Fork 455
chore: force cmdliner doc argument to be explicit #12728
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Leonidas-from-XIV
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's a reasonable change. Maybe it would be good to add a comment in places where ~doc:None exists with the TODO of adding documentation?
|
I would regard any |
|
Yeah, but it is hard to search for and hard to know for readers so having a |
194e8df to
8bbec0e
Compare
Leonidas-from-XIV
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I think except for the boot/libs.ml change this is good to go.
8bbec0e to
41fbd57
Compare
Signed-off-by: Ali Caglayan <[email protected]>
41fbd57 to
3bf0f7c
Compare
|
There are around 20 arguments undocumented. I think many of these have a sensible documentation, I'll try to get them done eventually. (After this PR) |
Signed-off-by: Ambre Austen Suhamy <[email protected]>
Signed-off-by: Ambre Austen Suhamy <[email protected]>
A common issue we have is undocumented arguments. It doesn't help that cmdliner hides the doc argument making it easy to miss. This is a common point of confusion for users #12722. In order to aid this we make the argument explicit. This makes it more apparent what is documented and what isn't.