From c25ace92c6f7d6bf697f6440d713726c56531cf7 Mon Sep 17 00:00:00 2001 From: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> Date: Mon, 2 Oct 2023 18:16:20 -0600 Subject: [PATCH] a few more edits to contrib.rst --- docs/contrib.rst | 28 ---------------------------- 1 file changed, 28 deletions(-) diff --git a/docs/contrib.rst b/docs/contrib.rst index 8e24debf..21cd80f9 100644 --- a/docs/contrib.rst +++ b/docs/contrib.rst @@ -92,7 +92,6 @@ A more detailed description of each step is provided in following sections. **Make your changes** #. `Understanding the codebase`_. -#. `Write and run tests`_. #. :ref:`Generate ` and :ref:`check ` the documentation. **Contribute your code** @@ -278,33 +277,6 @@ need to modify to incorporate your code into the package. These include: we add to in the same PR as the code changes. -Write and run tests -------------------- - -``geocat-viz`` uses `pytest `__ for unit tests. Currently, -we have unit tests written in both ``pytest`` and ``unittest``. We are in the -process of converting all of our tests to ``pytest`` and we encourage you to -write new tests using ``pytest``. - -To run the tests locally, use the following command from the root of the -repository: - -.. code-block:: bash - - pytest - -To run a specific test, use the following command: - -.. code-block:: bash - - pytest tests/test_mod.py::test_func - -These tests will also run automatically when you open a pull request using -GitHub Actions and the ``.github/workflows/ci.yml`` file. - -See the `pytest documentation `__ for more information. - - ************* Documentation *************