Added docstrings to all functions

mausoleum/tests/test_wrapper.py

@@ -6,64 +6,74 @@
 
 @pytest.fixture
 def name():
+    """Use test.tomb as the tomb name to pass to test functions."""
     return 'test.tomb'
 
 
 @pytest.fixture
 def key():
+    """Use test.tomb.key as the tomb key name to pass to test functions."""
     return 'test.tomb.key'
 
 
 @pytest.fixture
 def password():
+    """Use SUPER_SECURE_PASSWORD as the tomb password to pass to test functions."""
     return 'SUPER_SECURE_PASSWORD'
 
 
 def test_dig_tomb(name):
+    """Test creation of a new tomb container with a size of 10mb."""
     wrapper.dig_tomb(name, 10)
 
 
 def test_forge_tomb(key, password):
+    """Test creation of a new tomb key for the created tomb container."""
     wrapper.forge_tomb(key, password, debug=True)
 
 
 def test_lock_tomb(name, key, password):
+    """Test locking the tomb container with the created key."""
     wrapper.lock_tomb(name, key, password, debug=True)
 
 
 def test_cli_enter(name, password):
+    """Test the enter CLI command."""
     runner = CliRunner()
     result = runner.invoke(wrapper.cli, ['enter', name], input=password)
     assert not result.exception
 
 
 def test_list_tombs():
+    """Test that opened tombs are discovered."""
     assert '[test]' in wrapper.list_tombs()[0]
 
 
 def test_close_tomb():
+    """Test closing the created tomb."""
     wrapper.close_tomb()
-
-
-def test_list_tombs_closed():
     assert wrapper.list_tombs() == []
 
 
 def test_close_all_tombs(name, key, password):
+    """Test closing a tomb by opening the created tomb container."""
     wrapper.open_tomb(name, key, password)
     wrapper.close_tombs()
 
 
 def test_tomb_slam(name, key, password):
+    """Test force closing a tomb by opening the create tomb container."""
     wrapper.open_tomb(name, key, password)
     wrapper.slam_tombs()
 
 
 def test_resize_tomb(name, key, password):
-    wrapper.resize_tomb(name, 10, key, password)
+    """Test resizing the created tomb to 20mb."""
+    wrapper.resize_tomb(name, 20, key, password)
 
 
 def test_resize_cli(name, password):
+    """Test the resize CLI command."""
     runner = CliRunner()
     result = runner.invoke(wrapper.cli, ['alter', '--open', name, '30'], input=password)
     assert not result.exception