From 90c28c24180a5527841869bc2b2b4183cd7f434f Mon Sep 17 00:00:00 2001 From: Dave Hall Date: Thu, 1 Feb 2024 23:36:55 +0000 Subject: [PATCH] Documentation improvements (#62) - Better package description. - Better URLs for usage docs. --- docs/index.rst | 6 +++--- docs/installing.rst | 2 +- docs/log-capturing.rst | 4 ++-- docs/{usage-pytest.rst => using-pytest.rst} | 0 docs/{usage-unittest.rst => using-unittest.rst} | 0 logot/unittest.py | 2 +- pyproject.toml | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) rename docs/{usage-pytest.rst => using-pytest.rst} (100%) rename docs/{usage-unittest.rst => using-unittest.rst} (100%) diff --git a/docs/index.rst b/docs/index.rst index 4faaf8c1..19841228 100644 --- 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 index bdc291d3..6a4249db 100644 --- 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 index 2ec74c96..00774dce 100644 --- 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 b/docs/using-pytest.rst similarity index 100% rename from docs/usage-pytest.rst rename to docs/using-pytest.rst diff --git a/docs/usage-unittest.rst b/docs/using-unittest.rst similarity index 100% rename from docs/usage-unittest.rst rename to docs/using-unittest.rst diff --git a/logot/unittest.py b/logot/unittest.py index 1d94e9da..0cfd65da 100644 --- 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 index 43bc0103..04f406d1 100644 --- 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 "] license = "MIT" readme = "README.md"