chore: force cmdliner doc argument to be explicit#12728
chore: force cmdliner doc argument to be explicit#12728Leonidas-from-XIV merged 1 commit intoocaml:mainfrom
Conversation
Leonidas-from-XIV
left a comment
There was a problem hiding this comment.
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.
Thanks! I think except for the boot/libs.ml change this is good to go.
8bbec0e to
41fbd57
Compare
Signed-off-by: Ali Caglayan <alizter@gmail.com>
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 <ambre@tarides.com>
Signed-off-by: Ambre Austen Suhamy <ambre@tarides.com>
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.