implement #87

Author: bckohan

CONTRIBUTING.md

@@ -12,31 +12,21 @@
 
 # Contributing
 
-Contributions are encouraged! Please use the issue page to submit feature
-requests or bug reports. Issues with attached PRs will be given priority and
-have a much higher likelihood of acceptance. Please also open an issue and
-associate it with any submitted PRs. That said, the aim is to keep this library
-as lightweight as possible. Only features with broad-based use cases will be
-considered.
+Contributions are encouraged! Please use the issue page to submit feature requests or bug reports. Issues with attached PRs will be given priority and have a much higher likelihood of acceptance. Please also open an issue and associate it with any submitted PRs. That said, the aim is to keep this library as lightweight as possible. Only features with broad-based use cases will be considered.
 
-We are actively seeking additional maintainers. If you're interested, please
-[contact me](https://github.com/bckohan).
+We are actively seeking additional maintainers. If you're interested, please [contact me](https://github.com/bckohan).
 
 ## Installation
 
-`django-typer` uses [Poetry](https://python-poetry.org/) for environment, package, and dependency
-management:
+`django-typer` uses [Poetry](https://python-poetry.org/) for environment, package, and dependency management:
 
 ```shell
 poetry install
 ```
 
 ## Documentation
 
-`django-typer` documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/) with the
-[readthedocs](https://readthedocs.org/) theme. Any new feature PRs must provide updated documentation for
-the features added. To build the docs run doc8 to check for formatting issues
-then run Sphinx:
+`django-typer` documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/) with the [readthedocs](https://readthedocs.org/) theme. Any new feature PRs must provide updated documentation for the features added. To build the docs run doc8 to check for formatting issues then run Sphinx:
 
 ```bash
 cd ./doc
@@ -46,11 +36,7 @@ poetry run make html
 
 ## Static Analysis
 
-`django-typer` uses [ruff](https://docs.astral.sh/ruff/) for Python linting, header import
-standardization and code formatting. [mypy](http://mypy-lang.org/) and
-[pyright](https://github.com/microsoft/pyright) are used for static type checking. Before any PR
-is accepted the following must be run, and static analysis tools should not produce any errors or
-warnings. Disabling certain errors or warnings where justified is acceptable:
+`django-typer` uses [ruff](https://docs.astral.sh/ruff/) for Python linting, header import standardization and code formatting. [mypy](http://mypy-lang.org/) and [pyright](https://github.com/microsoft/pyright) are used for static type checking. Before any PR is accepted the following must be run, and static analysis tools should not produce any errors or warnings. Disabling certain errors or warnings where justified is acceptable:
 
 ```bash
 ./check.sh
@@ -64,10 +50,7 @@ To run static analysis without automated fixing you can run:
 
 ## Running Tests
 
-`django-typer` is set up to use [pytest](https://docs.pytest.org/en/stable/) to run unit tests. All the tests are
-housed in `django_typer/tests/tests.py`. Before a PR is accepted, all tests
-must be passing and the code coverage must be at 100%. A small number of
-exempted error handling branches are acceptable.
+`django-typer` is set up to use [pytest](https://docs.pytest.org/en/stable/) to run unit tests. All the tests are housed in `tests/tests.py`. Before a PR is accepted, all tests must be passing and the code coverage must be at 100%. A small number of exempted error handling branches are acceptable.
 
 To run the full suite:
 
@@ -81,10 +64,9 @@ To run a single test, or group of tests in a class:
 poetry run pytest <path_to_tests_file>::ClassName::FunctionName
 ```
 
-For instance, to run all tests in BasicTests, and then just the
-test_call_command test you would do:
+For instance, to run all tests in BasicTests, and then just the test_call_command test you would do:
 
 ```shell
-poetry run pytest django_typer/tests/tests.py::BasicTests
-poetry run pytest django_typer/tests/tests.py::BasicTests::test_call_command
+poetry run pytest tests/tests.py::BasicTests
+poetry run pytest tests/tests.py::BasicTests::test_call_command
 ```

django_typer/__init__.py

@@ -2487,7 +2487,7 @@ def command2(self, option: t.Optional[str] = None):
 
     We can see that our help renders like so:
 
-    .. typer:: django_typer.tests.apps.test_app.management.commands.chain.Command:typer_app
+    .. typer:: tests.apps.test_app.management.commands.chain.Command:typer_app
         :prog: ./manage.py chain
         :width: 80
         :convert-png: latex