aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-06-04 02:04:09 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2023-06-04 02:04:09 +0200
commit0be243cb369edf5683415d071f049e63833e6d2e (patch)
treeb5c2f63e1332351fdd2fd704196ea34c691ebfce
parentSplit __main__ into multiple modules. (diff)
downloadmuppet-strings-0be243cb369edf5683415d071f049e63833e6d2e.tar.gz
muppet-strings-0be243cb369edf5683415d071f049e63833e6d2e.tar.xz
Documentation formatting fixes.
-rw-r--r--muppet/format.py9
-rw-r--r--muppet/gather.py12
2 files changed, 11 insertions, 10 deletions
diff --git a/muppet/format.py b/muppet/format.py
index 43eaa7d..c9bce7c 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 d7a6645..a214507 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