🧪 Annotate pytest settings

Author: webknjaz

pytest.ini

@@ -9,17 +9,20 @@ addopts =
   # Report all the things == -rxXs:
   -ra
 
-  # Show local variables in tracebacks
+  # Show values of the local vars in errors/tracebacks:
   --showlocals
 
   # Autocollect and invoke the doctests from all modules:
   # https://docs.pytest.org/en/stable/doctest.html
   --doctest-modules
 
+  # dump the test results in junit format:
   --junitxml=.test-results/pytest/results.xml
 
-  # `pytest-cov`:
+  # Pre-load the `pytest-cov` plugin early:
   -p pytest_cov
+
+  # `pytest-cov`:
   --no-cov-on-fail
   --cov
   --cov-branch
@@ -52,13 +55,15 @@ filterwarnings =
 
 # https://docs.pytest.org/en/stable/usage.html#creating-junitxml-format-files
 junit_duration_report = call
+# xunit1 contains more metadata than xunit2 so it's better for CI UIs:
 junit_family = xunit1
 junit_logging = all
 junit_log_passing_tests = true
 junit_suite_name = ansible_pygments_test_suite
 
 minversion = 6.2.0
 
+# Optimize pytest's lookup by restricting potentially deep dir tree scan:
 norecursedirs =
   build
   dist