Repository navigation
Consistently show default values in the web manual, man pages, and --help usage #8387
Description
Activity
That is interesting and definitely an oversight, thanks for reporting.
The same thing occurs with
man gh-project-item-list(our actual man pages), whereas the help text (what I think you refer to as man pages) do.The generation of these man pages is kinda gnarly, but I'm happy to mark this
help wantedand if anyone wants to pick it up and needs direction we can certainly provide that.Sorry. I did mean the help text not man page.
Could you point me in the right direction? I would like to contribute
Great, thanks for jumping in. Right now I can't put together all the pieces of the puzzle because I'm short on time but the gist of it is I believe the changes are going to be around:
I think the flags expose a
DefValueproperty that could be used.And I believe you can generate the artifacts using
make site-docsandmake manpages(but I haven't confirmed this right now).If you need more pointers let me know and I'll try to make more time later!
@zsloane @williammartin : could someone help me understand what is missing from
man gh-project-item-listand its online page?
Aside from excess spacing, they appear consistent of an experience, I don't see where we show default values in the man page as claimed.
UPDATE: Thanks to @williammartin for calling out that we want the default values that the
gh ... --helppages show to be reflected on both the man pages and the CLI website 👍- changed the title
[-]Show default values in the web manual[/-][+]Consistently show default values in the web manual, man pages, and --help usage[/+]on Dec 1, 2023
CLI Feedback
The man pages show the default values for flags (such as --limit default of 30, issue list --state default of open, etc) but the web manual does not
It took me longer than I care to admit to figure out why my
gh project item-listcall without a limit set wasn't including all my project items even though"totalCount"was reporting ~200+ (my total number of items)