Hi! Thanks for the pull request. Please ensure that this change is linked to an issue by mentioning an issue number in the description of the pull request. If this pull request would close the issue, please put the word 'Fixes' before the issue number somewhere in the pull request body. If this is a tiny change like fixing a typo, feel free to ignore this message.

Also, while going through the documentation, I noticed that the gh manual/docs (https://cli.github.com/manual) displays long descriptions from short descriptions differently. Specifically, a command displays a long description after the usage whereas a short description is displayed before the usage. It seems that the short description is used for the command a long one does not exist.

Example:

• Long: https://cli.github.com/manual/gh_alias_list
• Short: https://cli.github.com/manual/gh_alias_delete

Is this intentional? To me, this looks strange, at least in the case of gh alias.

Let me know if I should open up an issue to discuss this topic.

It seems that the short description is used for the command a long one does not exist.

@kevhlee can you clarify this sentence, please? I'm not sure I understood what it's saying.

Specifically, a command displays a long description after the usage whereas a short description is displayed before the usage. It seems that the short description is used for the command a long one does not exist.

@kevhlee This is intentional. I've reviewed the examples you've shared and it doesn't seem particularly jarring to me! The idea is that the command usage line is presented early in the documentation; that's why the long description is only shown after.

Hi @mislav and @waldyrious,

@kevhlee This is intentional. I've reviewed the examples you've shared and it doesn't seem particularly jarring to me! The idea is that the command usage line is presented early in the documentation; that's why the long description is only shown after.

I see. Thanks for the clarification/confirmation! Just wanted to make sure.