Document jsonyx.tool

nineteendo · Aug 2, 2024 · 3d40277 · 3d40277
1 parent e19ada7
commit 3d40277
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -184,6 +184,8 @@ Functions
 .. autofunction:: jsonyx.loads
 .. autofunction:: jsonyx.read
 .. autofunction:: jsonyx.write
+.. autofunction:: jsonyx.tool.register
+.. autofunction:: jsonyx.tool.run
 
 Classes
 -------
@@ -202,6 +204,9 @@ Classes
 .. autoclass:: jsonyx.Encoder
     :members:
 
+.. autoclass:: jsonyx.tool.JSONNamespace
+    :members:
+
 Exceptions
 ----------
 

diff --git a/src/jsonyx/tool.py b/src/jsonyx/tool.py
@@ -30,7 +30,11 @@ class JSONNamespace:
 
 
 def register(parser: ArgumentParser) -> None:
-    """Register JSON tool."""
+    """Register JSON tool.
+
+    :param parser: an argument parser
+    :type parser: ArgumentParser
+    """
     parser.add_argument(
         "filename",
         nargs="?",
@@ -79,7 +83,11 @@ def register(parser: ArgumentParser) -> None:
 
 
 def run(args: JSONNamespace) -> None:
-    """Run JSON tool."""
+    """Run JSON tool.
+
+    :param args: the commandline arguments
+    :type args: JSONNamespace
+    """
     if args.filename:
         filename: str = args.filename
         s: bytes | str = Path(filename).read_bytes()