diff options
| author | Keewis <keewis@posteo.de> | 2022-02-23 22:37:04 +0100 |
|---|---|---|
| committer | Keewis <keewis@posteo.de> | 2022-02-23 22:37:04 +0100 |
| commit | 5f72edbcaa0f0f4ee2b3eadde566fdeb9845eb16 (patch) | |
| tree | adfa5f1e9d9283c827b881df3196c2063bddf39a /docs | |
| parent | d9e1e9180bd84ffe7777ad85e75c5be36936ff56 (diff) | |
| parent | 43287b365e647673978dac6e4f9f8f11c6ef9469 (diff) | |
| download | pint-5f72edbcaa0f0f4ee2b3eadde566fdeb9845eb16.tar.gz | |
Merge branch 'master' into formatter-docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.rst | 6 | ||||
| -rw-r--r-- | docs/developers_reference.rst | 3 |
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 46ee6d6..ad2914f 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -77,8 +77,12 @@ We use pytest_ for testing. If you contribute code you need to add tests: - When using classes, derive from `QuantityTestCase`. - Use `parametrize` as much as possible. - Use `fixtures` (see conftest.py) instead of instantiating the registry yourself. -- Checkout `helpers.py` for some convenience functions before reinventing the wheel. + Check out the existing fixtures before creating your own. - When your test does not modify the registry, use `sess_registry` fixture. +- **Do not** create a unit registry outside a test or fixture setup. +- If you need a specific registry, and you need to reuse it create a + fixture in your test module called `local_registry` or similar. +- Checkout `helpers.py` for some convenience functions before reinventing the wheel. Running tests and building documentation diff --git a/docs/developers_reference.rst b/docs/developers_reference.rst index f2be046..02f114e 100644 --- a/docs/developers_reference.rst +++ b/docs/developers_reference.rst @@ -50,6 +50,9 @@ All Modules .. automodule:: pint.systems :members: +.. automodule:: pint.testing + :members: + .. automodule:: pint.unit :members: |
