Add comments to decorated tests

PlasmaPy · Feb 23, 2024 · c5ad7b0 · c5ad7b0
1 parent 2b1e568
commit c5ad7b0
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/plasmapy/utils/data/tests/test_downloader.py b/plasmapy/utils/data/tests/test_downloader.py
@@ -19,7 +19,7 @@
 
 
 @pytest.mark.parametrize(("filename", "expected"), test_files)
-@pytest.mark.flaky(reruns=5)
+@pytest.mark.flaky(reruns=5)  # in case of intermittent connection to World Wide Web™
 def test_get_file(filename, expected, tmp_path) -> None:
     """Test the get_file function."""
     # Delete file if it already exists, so the test always downloads it
@@ -39,7 +39,7 @@ def test_get_file(filename, expected, tmp_path) -> None:
         downloader.get_file(filename, directory=tmp_path)
 
 
-@pytest.mark.flaky(reruns=5)
+@pytest.mark.flaky(reruns=5)  # in case of intermittent connection to World Wide Web™
 def test_get_file_NIST_PSTAR_datafile(tmp_path) -> None:
     """Test the get_file function on a NIST PSTAR datafile."""
     filename = "NIST_PSTAR_aluminum.txt"