update naming and docs

src/pymaccounter/__init__.py

@@ -2,4 +2,4 @@
 __init__.py for pymaccounter
 """
 
-from .runner import run_test
+from .runner import pipeline_run_tests

src/pymaccounter/pipeline.py

@@ -12,7 +12,7 @@
 import dagger
 
 
-async def test(
+async def pipeline_run_tests(
     tests_to_run: List[str], test_dir: str = "src/pymaccounter/tests"
 ) -> None:
     """
@@ -22,19 +22,21 @@ async def test(
         # get reference to the local project
         dockerfile_dir = client.host().directory(".")
 
-        async def test_version(test_to_run: str, test_dir: str):
+        async def run_test(test_to_run: str, test_dir: str):
+            """ """
             full_test_to_run = f"{test_dir}/{test_to_run}"
 
             # build a python container based on Dockerfile and run test
             python = (
                 client.container(
                     # explicitly set the container to be a certain platform type
                     platform=dagger.Platform("linux/amd64")
-                )
-                .build(
+                ).build(
                     context=dockerfile_dir,
+                    # uses a dockerfile to create the container
                     dockerfile="./src/pymaccounter/Dockerfile",
                 )
+                # run the python test through a poetry environment
                 .with_exec(["poetry", "run", "python", full_test_to_run])
             )
 
@@ -44,7 +46,8 @@ async def test_version(test_to_run: str, test_dir: str):
 
         # when this block exits, all tasks will be awaited (i.e., executed)
         async with anyio.create_task_group() as tg:
+            # run each test provided individually
             for test_to_run in tests_to_run:
-                tg.start_soon(test_version, test_to_run, test_dir)
+                tg.start_soon(run_test, test_to_run, test_dir)
 
     print("All tests have finished")

src/pymaccounter/runner.py

@@ -7,16 +7,17 @@
 import anyio
 import fire
 
-from pymaccounter.pipeline import test
+from pymaccounter.pipeline import pipeline_run_tests
 
 
-def run_test(tests_to_run: List[str]) -> None:
+def run_tests(tests_to_run: List[str]) -> None:
     """
     Helper function to run dagger testing pipeline
     """
 
-    anyio.run(test, tests_to_run)
+    anyio.run(pipeline_run_tests, tests_to_run)
 
 
 if __name__ == "__main__":
-    fire.Fire(run_test)
+    # creats a CLI through Python Fire for run_test
+    fire.Fire(run_tests)