feat(defaults): do not display a description if none exists

telekom-mms · Oct 10, 2024 · c8ade79 · c8ade79
1 parent 18f09c5
commit c8ade79
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 3 deletions.
diff --git a/aar_doc/core.py b/aar_doc/core.py
@@ -171,7 +171,7 @@ def parse_options(ctx: typer.Context) -> dict:
                 details["display_required"] = (
                     "yes" if details.get("required", False) else "no"
                 )
-                description = details["description"]
+                description = details["description"] if "description" in details else ""
                 details["display_description"] = (
                     (
                         description

diff --git a/aar_doc/defaults.py b/aar_doc/defaults.py
@@ -56,15 +56,14 @@ def add_default(
         self,
         name: str,
         value: Any,
-        description: str | list = "No description provided.",
+        description: str | list,
     ) -> None:
         """Add a default.
 
         Args:
             name (str): Variable name of the default.
             value (Any): Value of the default.
             description (str, optional): Description of the default.
-            Defaults to "No description provided.".
         """
         if isinstance(value, str):
             value = value.strip()

diff --git a/tests/fixtures/roles/generate_defaults/defaults/main.yml b/tests/fixtures/roles/generate_defaults/defaults/main.yml
@@ -33,6 +33,7 @@ generate_defaults_dict:
   value3: third value
 # A string value that can be overwritten
 generate_defaults_overwrite: original value
+generate_defaults_no_description: foo
 # A multiline string value
 generate_defaults_str_multiline: |-
   This is a multi line string.

diff --git a/tests/fixtures/roles/generate_defaults/defaults/overwrite.yml b/tests/fixtures/roles/generate_defaults/defaults/overwrite.yml
@@ -33,6 +33,7 @@ generate_defaults_dict:
   value3: third value
 # A string value that was overwritten
 generate_defaults_overwrite: overwritten value
+generate_defaults_no_description: foo
 # A multiline string value
 generate_defaults_str_multiline: |-
   This is a multi line string.

diff --git a/tests/fixtures/roles/generate_defaults/meta/argument_specs.yml b/tests/fixtures/roles/generate_defaults/meta/argument_specs.yml
@@ -67,6 +67,10 @@ argument_specs:
         type: str
         required: true
         description: An option without a default
+      generate_defaults_no_description:
+        type: str
+        required: true
+        default: "foo"
   alternate:
     short_description: The alternate entry point for the defaults role.
     options: