Strip argument documentation from command help text. (#4451)

Click stops processing docstrings when it encounters a formfeed (\f)
character. We can use this to keep the method argument documentation out
of the command help syntax.

See
https://click.palletsprojects.com/en/stable/documentation/#truncating-help-texts

Author: Qalthos

src/molecule/command/check.py

@@ -73,6 +73,7 @@ def check(  # noqa: PLR0913
 ) -> None:  # pragma: no cover
     """Use the provisioner to perform a Dry-Run (destroy, dependency, create, prepare, converge).
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         scenario_name: Name of the scenario to target.
@@ -81,7 +82,7 @@ def check(  # noqa: PLR0913
         parallel: Whether the scenario(s) should be run in parallel.
         report: Whether to show an after-run summary report.
         shared_inventory: Whether the inventory should be shared between scenarios.
-    """
+    """  # noqa: D301
     args: MoleculeArgs = ctx.obj.get("args")
     subcommand = base._get_subcommand(__name__)  # noqa: SLF001
     command_args: CommandArgs = {

src/molecule/command/cleanup.py

@@ -72,14 +72,15 @@ def cleanup(
 
     Any changes made to external systems during the stages of testing.
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         scenario_name: Name of the scenario to target.
         exclude: Name of the scenarios to avoid targeting.
         __all: Whether molecule should target scenario_name or all scenarios.
         report: Whether to show an after-run summary report.
         shared_inventory: Whether the inventory should be shared between scenarios.
-    """
+    """  # noqa: D301
     args: MoleculeArgs = ctx.obj.get("args")
     subcommand = base._get_subcommand(__name__)  # noqa: SLF001
     command_args: CommandArgs = {

src/molecule/command/converge.py

@@ -68,6 +68,7 @@ def converge(  # noqa: PLR0913
 ) -> None:  # pragma: no cover
     """Use the provisioner to configure instances (dependency, create, prepare converge).
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         scenario_name: Name of the scenario to target.
@@ -76,7 +77,7 @@ def converge(  # noqa: PLR0913
         ansible_args: Arguments to forward to Ansible.
         report: Whether to show an after-run summary report.
         shared_inventory: Whether the inventory should be shared between scenarios.
-    """
+    """  # noqa: D301
     args: MoleculeArgs = ctx.obj.get("args")
     subcommand = base._get_subcommand(__name__)  # noqa: SLF001
     command_args: CommandArgs = {

src/molecule/command/create.py

@@ -83,6 +83,7 @@ def create(  # noqa: PLR0913
 ) -> None:  # pragma: no cover
     """Use the provisioner to start the instances.
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         scenario_name: Name of the scenario to target.
@@ -91,7 +92,7 @@ def create(  # noqa: PLR0913
         __all: Whether molecule should target scenario_name or all scenarios.
         report: Whether to show an after-run summary report.
         shared_inventory: Whether the inventory should be shared between scenarios.
-    """
+    """  # noqa: D301
     args: MoleculeArgs = ctx.obj.get("args")
     subcommand = base._get_subcommand(__name__)  # noqa: SLF001
     command_args: CommandArgs = {

src/molecule/command/dependency.py

@@ -65,14 +65,15 @@ def dependency(
 ) -> None:  # pragma: no cover
     """Manage the role's dependencies.
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         scenario_name: Name of the scenario to target.
         exclude: Name of the scenarios to avoid targeting.
         __all: Whether molecule should target scenario_name or all scenarios.
         report: Whether to show an after-run summary report.
         shared_inventory: Whether the inventory should be shared between scenarios.
-    """
+    """  # noqa: D301
     args: MoleculeArgs = ctx.obj.get("args")
     subcommand = base._get_subcommand(__name__)  # noqa: SLF001
     command_args: CommandArgs = {

src/molecule/command/destroy.py

@@ -87,6 +87,7 @@ def destroy(  # noqa: PLR0913
 ) -> None:  # pragma: no cover
     """Use the provisioner to destroy the instances.
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         scenario_name: Name of the scenario to target.
@@ -96,7 +97,7 @@ def destroy(  # noqa: PLR0913
         parallel: Whether the scenario(s) should be run in parallel mode.
         report: Whether to show an after-run summary report.
         shared_inventory: Whether the inventory should be shared between scenarios.
-    """
+    """  # noqa: D301
     args: MoleculeArgs = ctx.obj.get("args")
     subcommand = base._get_subcommand(__name__)  # noqa: SLF001
     command_args: CommandArgs = {

src/molecule/command/drivers.py

@@ -48,10 +48,11 @@ def drivers(
 ) -> None:  # pragma: no cover
     """List drivers.
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         format: Output format to use.
-    """
+    """  # noqa: D301
     drivers = []  # pylint: disable=redefined-outer-name
     for driver in api.drivers().values():
         description = str(driver)

src/molecule/command/idempotence.py

@@ -138,6 +138,7 @@ def idempotence(  # noqa: PLR0913
 
     After parse the output to determine idempotence.
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         scenario_name: Name of the scenario to target.
@@ -146,7 +147,7 @@ def idempotence(  # noqa: PLR0913
         ansible_args: Arguments to forward to Ansible.
         report: Whether to show an after-run summary report.
         shared_inventory: Whether the inventory should be shared between scenarios.
-    """
+    """  # noqa: D301
     args: MoleculeArgs = ctx.obj.get("args")
     subcommand = base._get_subcommand(__name__)  # noqa: SLF001
     command_args: CommandArgs = {

src/molecule/command/init/scenario.py

@@ -195,13 +195,14 @@ def scenario(
 
     If name is not specified the 'default' value will be used.
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         dependency_name: Name of dependency to initialize.
         driver_name: Name of driver to use.
         provisioner_name: Name of provisioner to use.
         scenario_name: Name of scenario to initialize.
-    """
+    """  # noqa: D301
     command_args: CommandArgs = {
         "dependency_name": dependency_name,
         "driver_name": driver_name,

src/molecule/command/list.py

@@ -80,11 +80,12 @@ def list_(
 ) -> None:  # pragma: no cover
     """List status of instances.
 
+    \f
     Args:
         ctx: Click context object holding commandline arguments.
         scenario_name: Name of the scenario to target.
         format: Output format type.
-    """
+    """  # noqa: D301
     args: MoleculeArgs = ctx.obj.get("args")
     subcommand = base._get_subcommand(__name__)  # noqa: SLF001
     command_args: CommandArgs = {"subcommand": subcommand, "format": format}