diff --git a/muppet/format.py b/muppet/format.py index 43eaa7dee18d3c476c022133c967850ed6575454..c9bce7ccacfe568f0ca20c881b6cc7bcc4fdd48a 100644 --- a/muppet/format.py +++ b/muppet/format.py @@ -1015,10 +1015,11 @@ def print_docstring(name: str, docstring: dict[str, Any]) -> str: """ Format docstrings as they appear in some puppet types. - Those types being - - puppet_classes, - - puppet_type_aliases, and - - defined_types + Those types being: + + * puppet_classes, + * puppet_type_aliases, and + * defined_types """ global param_doc diff --git a/muppet/gather.py b/muppet/gather.py index d7a66450af7bca4762b2ab3d4a84261bc009c7a8..a2145075696b0b391fb5eabe954eec3795c3cb3d 100644 --- a/muppet/gather.py +++ b/muppet/gather.py @@ -22,12 +22,12 @@ class ModuleEntry: """ One entry in a module. - Parameters: - name - local name of the module, should always be the basename - of path - path - Absolute path in the filesystem where the module can be - found. - strings_output - output of `puppet strings`. + :param name: + Local name of the module, should always be the basename of path + :param path: + Absolute path in the filesystem where the module can be found. + :param strings_output: + Output of ``puppet strings``. """ name: str