derivepassphrase.git

@@ -338,14 +338,17 @@ class CommandWithHelpGroups(click.Command):

     ) -> None:

         r"""Format options on the help listing, grouped into sections.

-        As part of the `--help` listing, list all options, but grouped

-        into sections according to the concrete [`click.Option`][]

-        subclass being used.  If the option is an instance of some

-        subclass `X` of [`derivepassphrase.cli.OptionGroupOption`][],

-        then the section heading and the epilog is taken from

-        `X.option_group_name` and `X.epilog`; otherwise, the section

-        heading is "Options" (or "Other options" if there are other

-        option groups) and the epilog is empty.

+        This is a callback for [`click.Command.get_help`][] that

+        implements the `--help` listing, by calling appropriate methods

+        of the `formatter`.  We list all options (like the base

+        implementation), but grouped into sections according to the

+        concrete [`click.Option`][] subclass being used.  If the option

+        is an instance of some subclass `X` of

+        [`derivepassphrase.cli.OptionGroupOption`][], then the section

+        heading and the epilog are taken from `X.option_group_name` and

+        `X.epilog`; otherwise, the section heading is "Options" (or

+        "Other options" if there are other option groups) and the epilog

+        is empty.

         Args:

             ctx:

@@ -353,6 +356,10 @@ class CommandWithHelpGroups(click.Command):

             formatter:

                 The formatter for the `--help` listing.

+        Returns:

+            Nothing.  Output is generated by calling appropriate methods

+            on `formatter` instead.

+

         """

         help_records: dict[str, list[tuple[str, str]]] = {}

         epilogs: dict[str, str] = {}