add documentation

Author: molly-moen

README.md

@@ -13,6 +13,10 @@ The current patches are:
 All Python Lab programs are prefixed with `setup_pythonlab()`, the method this package exposes, which only applies
 the matplotlib patch for now.
 
+## unittest_runner
+This tests adds some customization to the output of unit tests, and has a function to either run validation tests
+(more customized) or student tests (less customized).
+
 ## Setup
 - Install `pyenv`. 
     - See instructions [here](https://github.com/pyenv/pyenv?tab=readme-ov-file#getting-pyenv)

packages/unittest_runner/unittest_runner/run_tests.py

@@ -1,9 +1,13 @@
 import unittest
 from .validation_runner import ValidationTestResult
 
+# Run the tests in the given file pattern and display the results to the user.
+# Validation tests use the ValidationTestResult class to display only the short description of the test.
 def run_validation_tests(file_pattern):
   run_tests(file_pattern, ValidationTestResult)
 
+# Run the tests in the given file pattern and display the results to the user.
+# Student tests use the standard TextTestResult class to display the test name and short description.
 def run_student_tests(file_pattern):
   run_tests(file_pattern, unittest.TextTestResult)