Skip to content
Snippets Groups Projects
Commit 0be243cb authored by Hugo Hörnquist's avatar Hugo Hörnquist
Browse files

Documentation formatting fixes.

parent 07ba1d80
No related branches found
No related tags found
No related merge requests found
......@@ -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
......
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment