cli.github.com help topic page not rendering properly  #4322

Activity

1. samcoe

   added

   bugSomething isn't workingSomething isn't working

   on Sep 13, 2021
2. samcoe

   changed the title [-]CLI formatting doc not rendering properly [/-] [+]cli.github.com help topic page not rendering properly [/+] on Sep 13, 2021
3. samcoe

   added

   priority-3Affects a small number of users or is largely cosmeticAffects a small number of users or is largely cosmetic

   on Sep 13, 2021
4. samcoe

   added

   help wantedContributions welcomeContributions welcome

   on Oct 21, 2021
5. issyl0 commented on Oct 21, 2021

   

   issyl0

   on Oct 21, 2021

   Contributor

   More actions

   It looks like gh help formatting is defined in https://github.com/cli/cli/blob/trunk/pkg/cmd/root/help_topic.go#L81-L123. Comparing this to https://github.com/cli/cli/blob/trunk/pkg/cmd/release/download/download.go#L38-L56, which does render correctly, it's a very different way of writing it - split into "Examples", "Long" Cobra command heredocs vs. one single string. 🤔
6. mislav

   closed this as completedin #4661on Nov 2, 2021