From d6d466a456b62103e59eafed58038ade7d6ff90b Mon Sep 17 00:00:00 2001 From: Jacob Alheid Date: Mon, 9 Jun 2025 14:56:08 -0700 Subject: [PATCH] docs(sphinx): fixed several warnings and errors when building documentation --- docs/changes.rst | 2 +- docs/pytool.rst | 2 +- pytool/json.py | 2 +- pytool/lang.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/changes.rst b/docs/changes.rst index bd1ed14..22738b8 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -7,7 +7,7 @@ All releases """""""""""" Release are now tracked `on -GitHub _. Please visit there to see changes from `3.4.2` and later. Older releases diff --git a/docs/pytool.rst b/docs/pytool.rst index ff56a4b..dbb2114 100644 --- a/docs/pytool.rst +++ b/docs/pytool.rst @@ -111,7 +111,7 @@ issue `_. .. autofunction:: wrap :func:`columns` ------------- +--------------- .. autofunction:: columns diff --git a/pytool/json.py b/pytool/json.py index 980aaf6..315503e 100644 --- a/pytool/json.py +++ b/pytool/json.py @@ -57,7 +57,7 @@ def as_json(obj, **kwargs): :class:`bson.ObjectId`. :param object obj: An object to encode. - :param **kwargs: Any optional keyword arguments to pass to the \ + :param \*\*kwargs: Any optional keyword arguments to pass to the \ JSONEncoder :returns: JSON encoded version of `obj`. diff --git a/pytool/lang.py b/pytool/lang.py index fc67ca5..ba3bea3 100644 --- a/pytool/lang.py +++ b/pytool/lang.py @@ -538,7 +538,7 @@ def for_json(self, base_name=None): :param str base_name: Base namespace (optional) - This is compatible with the :module:`simplejson` `for_json` + This is compatible with the :mod:`simplejson` `for_json` behavior flag to recursively encode objects. Example::