diff --git a/docs/source/contributing/tests.rst b/docs/source/contributing/tests.rst index 044aa7ca..8fbf17aa 100644 --- a/docs/source/contributing/tests.rst +++ b/docs/source/contributing/tests.rst @@ -4,19 +4,16 @@ Testing JupyterHub and linting code =================================== -Unit test help validate that JupyterHub works the way we think it does, -and continues to do so when changes occur. They also help communicate -precisely what we expect our code to do. +Unit tests help confirming that JupyterHub works as intended and does so even when modifications are made. Additionally, they help in clarifying our expectations for our code. -JupyterHub uses `pytest `_ for all our tests. You -can find them under ``jupyterhub/tests`` directory in the git repository. +JupyterHub uses `pytest `_ for all the tests. You +can find them under the `jupyterhub/tests `_ directory in the git repository. Running the tests ================== -#. Make sure you have completed :ref:`contributing/setup`. You should be able - to start ``jupyterhub`` from the commandline & access it from your - web browser. This ensures that the dev environment is properly set +#. Make sure you have completed :ref:`contributing/setup`. Once completed, you should be able + to start ``jupyterhub`` through a web browser as well as the command line. By doing this, it is ensured that the dev environment is properly set up for tests to run. #. You can run all tests in JupyterHub @@ -57,7 +54,7 @@ Running the tests pytest -v jupyterhub/tests/test_api.py::test_shutdown - See the `pytest usage documentation `_ for more details. + For more information, refer to `pytest usage documentation `_. Test organisation ================= @@ -98,8 +95,7 @@ And fixtures to add functionality or spawning behavior: - ``bad_spawn``: enables the BadSpawner (a spawner that fails immediately) - ``slow_bad_spawn``: enables the SlowBadSpawner (a spawner that fails after a short delay) -See the `pytest fixtures documentation `_ -for how to use the existing fixtures, and how to create new ones. +For information on using the existing fixtures and creating new ones, refer to `pytest fixtures documentation `_ Troubleshooting Test Failures @@ -109,7 +105,7 @@ All the tests are failing ------------------------- Make sure you have completed all the steps in :ref:`contributing/setup` successfully, and -can launch ``jupyterhub`` from the terminal. +can launch ``jupyterhub`` from the terminal as well as the web browser. Code formatting and linting @@ -117,13 +113,13 @@ Code formatting and linting JupyterHub has adopted automatic code formatting and linting. As long as your code is valid, the pre-commit hook should take care of how it should look. -You can invoke the pre-commit hook by hand at any time with: +You can invoke the pre-commit hook manually at any time with: .. code:: bash pre-commit run -which should run any autoformatting on your code and tell you about any errors it couldn't fix automatically. +This should run any auto formatting on your code and tell you about any errors it couldn't fix automatically. You may also install `black integration `_ into your text editor to format code automatically.