Skip to content

Commit

Permalink
reworded function and class intros
Browse files Browse the repository at this point in the history
  • Loading branch information
ESadek-MO committed Nov 1, 2024
1 parent 7d07be2 commit 28aa24b
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/src/developers_guide/contributing_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ we do not deem consistency on this a vital concern.
Naming Test Classes and Functions
---------------------------------

Within a test module each tested method may have corresponding test classes,
for example:
When testing classes and their methods, each tested method within a test module
may have corresponding test classes, for example:

* ``Test_<name of public method>``
* ``Test_<name of public method>__<aspect of method>``
Expand Down Expand Up @@ -163,7 +163,8 @@ Within that file the tests might look something like:
def test_coord_already_present(self):
...
Within this test module there may be test classes, for example:
When testing functions, within the test module there may be test classes, for
example:

* ``Test``
* ``TestAspectOfFunction``
Expand Down Expand Up @@ -196,6 +197,7 @@ Within that file the tests might look something like:
...
There is no fixed naming scheme for integration tests.

.. _testing_tools:

Testing tools
Expand Down

0 comments on commit 28aa24b

Please sign in to comment.