Add pipx command

nineteendo · Sep 17, 2024 · 61ab6fc · 61ab6fc
1 parent 0b0063e
commit 61ab6fc
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/docs/source/get-started.rst b/docs/source/get-started.rst
@@ -40,7 +40,9 @@ To use :mod:`jsonyx`, first install it using pip,
 
  .. rubric:: pipx (PyPI)
 
- .. todo:: Add command
+ .. code-block:: console
+
+ $ pipx install jsonyx
 
  .. tab:: GitHub
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -93,6 +93,8 @@ to :ref:`install <installation>` the project.
  api/index
  cli
 
+.. todo:: Add specification
+
 .. toctree::
  :caption: About the Project
  :hidden:

diff --git a/src/jsonyx/_decoder.py b/src/jsonyx/_decoder.py
@@ -1,6 +1,5 @@
 # Copyright (C) 2024 Nice Zombies
 """JSON decoder."""
-# TODO(Nice Zombies): add specification
 from __future__ import annotations
 
 __all__: list[str] = [

diff --git a/src/jsonyx/_manipulator.py b/src/jsonyx/_manipulator.py
@@ -3,7 +3,6 @@
 # TODO(Nice Zombies): add error messages
 # TODO(Nice Zombies): raise JSONSyntaxError
 # TODO(Nice Zombies): update schema ID
-# TODO(Nice Zombies): write specification
 from __future__ import annotations
 
 __all__: list[str] = ["Manipulator"]