Documents mention search but give no information #4887

Activity

1. GadgetSteve

   added

   enhancementa request to improve CLIa request to improve CLI

   on Dec 11, 2021
2. cliAutomation

   added

   needs-triageneeds to be reviewedneeds to be reviewed

   on Dec 11, 2021
3. mislav

   added

   docs

   help wantedContributions welcomeContributions welcome

   and removed

   enhancementa request to improve CLIa request to improve CLI

   needs-triageneeds to be reviewedneeds to be reviewed

   on Dec 13, 2021
4. mislav commented on Dec 13, 2021

   

   mislav

   on Dec 13, 2021

   Contributor

   More actions

   @GadgetSteve Thank you for raising this issue.

   Out project layout documentation has some pointers about where the code for an individual command can be found, but we don't also document the fact that command documentation is embedded in its Go code. For example, gh issue list documentation:

   cli/pkg/cmd/issue/list/list.go

   Lines 55 to 64 in 2d0b946

   	Use: "list",
   	Short: "List and filter issues in this repository",
   	Example: heredoc.Doc(`
   	$ gh issue list -l "bug" -l "help wanted"
   	$ gh issue list -A monalisa
   	$ gh issue list -a "@me"
   	$ gh issue list --web
   	$ gh issue list --milestone "The big 1.0"
   	$ gh issue list --search "error no:assignee sort:created-asc"
   	`),

   Observe the Use, Short, Long (this command doesn't seem to have it), and Example fields. Every gh command (implemented as a Cobra command) has these strings which are later taken into account when generating documentation. To add/edit documentation, you can submit PRs to change these strings.
5. mislav

   closed this as completedin #5223on Feb 21, 2022