Documentation improvements (#62)

- Better package description. - Better URLs for usage docs.
etianen · Feb 1, 2024 · 90c28c2 · 90c28c2
1 parent 8463eae
commit 90c28c2
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 8 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,7 +15,7 @@ Log-based testing 🪵
 
 .. note::
 
-   These examples all show using :mod:`logot` with :mod:`pytest`. See :doc:`/usage-unittest` to learn about about using
+   These examples all show using :mod:`logot` with :mod:`pytest`. See :doc:`/using-unittest` to learn about about using
    :mod:`logot` with other testing frameworks.
 
 
@@ -148,7 +148,7 @@ Learn more about :mod:`logot` with the following guides:
    log-message-matching
    log-pattern-matching
    log-capturing
-   usage-pytest
-   usage-unittest
+   using-pytest
+   using-unittest
    installing
    api/index
diff --git a/docs/installing.rst b/docs/installing.rst
@@ -26,7 +26,7 @@ Installing package ``extras``
 
 Package extras for supported 3rd-party integrations:
 
-- ``pytest`` - :doc:`usage-pytest`
+- ``pytest`` - :doc:`using-pytest`
 
 
 Installing with Poetry

diff --git a/docs/log-capturing.rst b/docs/log-capturing.rst
@@ -17,8 +17,8 @@ Test framework integrations
 
 Use a supported test framework integration for automatic log capturing in tests:
 
-- :doc:`/usage-pytest`
-- :doc:`/usage-unittest`
+- :doc:`/using-pytest`
+- :doc:`/using-unittest`
 
 
 Capturing :mod:`logging` logs

diff --git a/docs/usage-pytest.rst → docs/using-pytest.rst b/docs/usage-pytest.rst → docs/using-pytest.rst
diff --git a/docs/usage-unittest.rst → docs/using-unittest.rst b/docs/usage-unittest.rst → docs/using-unittest.rst
diff --git a/logot/unittest.py b/logot/unittest.py
@@ -3,7 +3,7 @@
 
 .. seealso::
 
-    See :doc:`/usage-unittest` usage guide.
+    See :doc:`/using-unittest` usage guide.
 """
 from __future__ import annotations
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "logot"
 version = "0.3.2"
-description = "Log-based testing"
+description = "Test whether your code is logging correctly 🪵"
 authors = ["Dave Hall <dave@etianen.com>"]
 license = "MIT"
 readme = "README.md"