Skip to content

Commit ecbe0fe

Browse files
committed
test_sys_subset_data.py: Explain caller_n.
1 parent 05a2c28 commit ecbe0fe

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

python/ctsm/test/test_sys_subset_data.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ def tearDown(self):
4040
def _check_result_file_matches_expected(self, expected_output_files, caller_n):
4141
"""
4242
Loop through a list of output files, making sure they match what we expect.
43+
44+
caller_n should be an integer giving the number of levels above this function you need to
45+
traverse before you hit the actual test name. If the test is calling this function directly,
46+
caller_n = 1. If the test is calling a function that calls this function, caller_n = 2. Etc.
4347
"""
4448
all_files_present_and_match = True
4549
for basename in expected_output_files:

0 commit comments

Comments
 (0)