From e612752b047f48c9a7ac3a8ead10cd3176bc0ad0 Mon Sep 17 00:00:00 2001
From: inmantaci <ci@inmanta.com>
Date: Mon, 2 Aug 2021 15:59:57 +0200
Subject: [PATCH] Enhance the documentation of the `inmanta module build`
 command. (PR #3146)

# Description

I noticed that the documentation of the `inmanta module build` command could be improved, by adding the default values. This PR fixes that.

# Self Check:

- [ ] ~~Attached issue to pull request~~
- [x] Changelog entry
- [x] Type annotations are present
- [x] Code is clear and sufficiently documented
- [x] No (preventable) type errors (check using make mypy or make mypy-diff)
- [x] Sufficient test cases (reproduces the bug/tests the requested feature)
- [x] Correct, in line with design
- [x] End user documentation is included or an issue is created for end-user documentation

# Reviewer Checklist:

- [ ] Sufficient test cases (reproduces the bug/tests the requested feature)
- [ ] Code is clear and sufficiently documented
- [ ] Correct, in line with design
---
 .../unreleased/enhance-build-command-documentation.yml    | 4 ++++
 src/inmanta/moduletool.py                                 | 8 ++++++--
 2 files changed, 10 insertions(+), 2 deletions(-)
 create mode 100644 changelogs/unreleased/enhance-build-command-documentation.yml

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: <module_root>/dist",
+            default=None,
+            dest="output_dir",
         )
 
     def build(self, path: Optional[str] = None, output_dir: Optional[str] = None) -> str: