Switch to argparse.RawDescriptionHelpFormatter as the help formatter.

Fixes #42

Signed-off-by: Pedro Algarvio <[email protected]>

Author: s0undt3ch

changelog/42.added.rst

@@ -0,0 +1 @@
+Switch to `RawDescriptionHelpFormatter` as the formatter class. This will help to include properly indented examples.

src/ptscripts/parser.py

@@ -489,6 +489,7 @@ def __new__(cls) -> Parser:
                 description="Python Tools Scripts",
                 epilog="These tools are discovered under `<repo-root>/tools`.",
                 allow_abbrev=False,
+                formatter_class=argparse.RawDescriptionHelpFormatter,
             )
             instance.parser.add_argument("--version", action="version", version=__version__)
             log_group = instance.parser.add_argument_group("Logging")
@@ -700,6 +701,7 @@ def __init__(
             name.replace("_", "-"),
             help=help,
             description=description,
+            formatter_class=argparse.RawDescriptionHelpFormatter,
         )
         self.subparsers = self.parser.add_subparsers(
             title="Commands",
@@ -743,7 +745,12 @@ def command(  # noqa: ANN201,C901,PLR0912,PLR0915
             description = inspect.getdoc(func)
         if help is None and description is not None:
             help = description.splitlines()[0]
-        command = self.subparsers.add_parser(name=name, help=help, description=description)
+        command = self.subparsers.add_parser(
+            name=name,
+            help=help,
+            description=description,
+            formatter_class=argparse.RawDescriptionHelpFormatter,
+        )
 
         signature = inspect.signature(func)