adds comment.

Brown-University-Library · Jan 26, 2025 · d57e56b · d57e56b
1 parent acc8a65
commit d57e56b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/tests.py b/tests.py
@@ -57,6 +57,9 @@ def test_git_status_clean(self):
         """
         Checks that `On branch main` is detected properly.
         Assumes current-project is on branch `main`.
+
+        Note: just looking for the word 'clean' because one version of git says "working tree clean"
+            and another says "working directory clean". TODO: consider just checking the ok boolean.
         """
         cur_dir = Path('./').resolve()
         log.debug(f'cur_dir: {cur_dir}')