From 8fe00bf837fa3ddcae2afa823f09d8a77b489e93 Mon Sep 17 00:00:00 2001
From: Hans Fangohr <hans.fangohr@mpsd.mpg.de>
Date: Wed, 31 May 2023 12:38:32 +0200
Subject: [PATCH] improve documentation

---
 tests.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/tests.py b/tests.py
index b79ccf1..31b69dd 100644
--- a/tests.py
+++ b/tests.py
@@ -26,12 +26,15 @@ def test_os_chdir(tmp_path):
 
 
 def test_run_method(tmp_path):
+    """Run tests for run method."""
+
     run = mod.run
 
     # test a command with options:
     assert run(["date", "+%Y-%m-%d"]).returncode == 0
     assert run("date +%Y-%m-%d", shell=True).returncode == 0
 
+    # tests interacting with the file system
     with mod.os_chdir(str(tmp_path)):
         # ensure single string command works
         assert run(("ls -l"), shell=True).returncode == 0
-- 
GitLab