Skip to content

Commit

Permalink
chore: added clarification docstring; corrected TestClusterPop docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
ethan-moss committed Sep 15, 2023
1 parent ede5354 commit 94ac2f0
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion tests/urban_centres/test_urban_centres.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
"""Unit tests for transport_performance/urban_centres/urban_centres_class.
TODO: add docs.
Note: in the class parameterised tests below there are some arguments that are
not used across all tests within them. This is a deliberate design choice,
since pytest expects all parameterised arguments to be passed - removing or
excluding from a signle test triggers errors. The alternative would be to
separate the tests and reparameterise each separetly, but this would lead to a
larger codebase that is more difficult to maintain.
"""

import os
Expand Down Expand Up @@ -354,7 +361,7 @@ def test_diag_output(
],
)
class TestClusterPop:
"""Class to test effect of diagonal boolean on output."""
"""Class to test effect of clustering pop threshold on output."""

def test_cluster_pop_t(
self,
Expand Down

0 comments on commit 94ac2f0

Please sign in to comment.