By default, all option group help sections are aligned , meaning that they
│ │ │ │ share the same column widths. Many people find this visually pleasing and this
│ │ │ │ is also the default behavior of argparse
│ │ │ │ Nonetheless, if some of your option groups have shorter options, alignment may
│ │ │ │ result in a lot of wasted space and definitions quite far from option names,
│ │ │ │ which is bad for readability. See this biased example to compare the two modes:
│ │ │ │
│ │ │ │ -
│ │ │ │ -
│ │ │ │ +
│ │ │ │ Aligned
│ │ │ │
│ │ │ │
│ │ │ │
│ │ │ │ +
│ │ │ │ Non-aligned
│ │ │ │
│ │ │ │ Adding full sections
│ │ │ │ This is my favourite way of structuring my sections.
│ │ │ │ You can find a runnable example that implements part of the help of Git
│ │ │ │ here .
│ │ │ │ The code below is based on that example.
│ │ │ │
│ │ │ │ -
│ │ │ │ -
│ │ │ │ +
│ │ │ │ Code
│ │ │ │
import cloup
│ │ │ │ from .commands import ( # import your subcommands
│ │ │ │ git_clone , git_init , git_rm , git_sparse_checkout , git_mv ,
│ │ │ │ git_status , git_log )
│ │ │ │
│ │ │ │ @cloup . group ( 'git' )
│ │ │ │ @@ -345,16 +345,16 @@
│ │ │ │ # Subcommands that are not assigned to a specific section
│ │ │ │ # populate the "default section"
│ │ │ │ git . add_command ( git_status )
│ │ │ │ git . add_command ( git_log )
│ │ │ │
│ │ │ │
│ │ │ │
│ │ │ │ +
│ │ │ │ Generated help
│ │ │ │