better docstring

Author: justmobilize

adafruit_json_stream.py

@@ -41,9 +41,15 @@ def read(self):
         return char
 
     def fast_forward(self, closer, *, return_object=False):
-        """Read through the stream until the character is ``closer``, ``]``
+        """
+        Read through the stream until the character is ``closer``, ``]``
         (ending a list) or ``}`` (ending an object.) Intermediate lists and
-        objects are skipped."""
+        objects are skipped.
+
+        :param str closer: the character to read until
+        :param bool return_object: read until the closer,
+          and then parse the data and return as an object
+        """
 
         closer = ord(closer)
         close_stack = [closer]

tox.ini

@@ -0,0 +1,41 @@
+# SPDX-FileCopyrightText: 2022 Kevin Conley
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+[tox]
+envlist = py311
+
+[testenv]
+description = run tests
+deps =
+    pytest==7.4.3
+    requests
+commands = pytest
+
+[testenv:coverage]
+description = run coverage
+deps =
+    pytest==7.4.3
+    pytest-cov==4.1.0
+    requests
+package = editable
+commands =
+    coverage run --source=. --omit=tests/* --branch {posargs} -m pytest
+    coverage report
+    coverage html
+
+[testenv:lint]
+description = run linters
+deps =
+    pre-commit==3.6.0
+skip_install = true
+commands = pre-commit run {posargs}
+
+[testenv:docs]
+description = build docs
+deps =
+    -r requirements.txt
+    -r docs/requirements.txt
+skip_install = true
+commands = sphinx-build -E -W -b html docs/. _build/html