diff --git a/changelogs/unreleased/enhance-build-command-documentation.yml b/changelogs/unreleased/enhance-build-command-documentation.yml new file mode 100644 index 0000000000..4a82215882 --- /dev/null +++ b/changelogs/unreleased/enhance-build-command-documentation.yml @@ -0,0 +1,4 @@ +--- +description: Enhance the documentation of the `inmanta module build` command. +change-type: patch +destination-branches: [master] diff --git a/src/inmanta/moduletool.py b/src/inmanta/moduletool.py index e28265aed9..b97d85159c 100644 --- a/src/inmanta/moduletool.py +++ b/src/inmanta/moduletool.py @@ -340,11 +340,15 @@ def modules_parser_config(cls, parser: ArgumentParser): build = subparser.add_parser("build", help="Build a Python package from a V2 module.") build.add_argument( "path", - help="The path to the module that should be built", + help="The path to the module that should be built. By default, the current working directory is used.", nargs="?", ) build.add_argument( - "-o", "--output-dir", help="The directory where the Python package will be stored.", default=None, dest="output_dir" + "-o", + "--output-dir", + help="The directory where the Python package will be stored. Default: /dist", + default=None, + dest="output_dir", ) def build(self, path: Optional[str] = None, output_dir: Optional[str] = None) -> str: