From 94ac2f0a6d37ceda5f52e628b90610e1cf94141c Mon Sep 17 00:00:00 2001 From: Ethan Moss Date: Fri, 15 Sep 2023 14:09:41 +0100 Subject: [PATCH] chore: added clarification docstring; corrected TestClusterPop docstring --- tests/urban_centres/test_urban_centres.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/tests/urban_centres/test_urban_centres.py b/tests/urban_centres/test_urban_centres.py index eab7c49a..10ecaf53 100644 --- a/tests/urban_centres/test_urban_centres.py +++ b/tests/urban_centres/test_urban_centres.py @@ -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 @@ -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,