Finish tidying up docstrings.

Author: JoeZiminski

tests/tests_integration/base.py

@@ -17,8 +17,8 @@ class BaseTest:
     @pytest.fixture(scope="function")
     def no_cfg_project(test):
         """
-        Fixture that creates an empty project. Ignore the warning
-        that no configs are setup yet.
+        Fixture that creates an empty project. Ignore the
+        warning that no configs are set up yet.
         """
         test_utils.delete_project_if_it_exists(TEST_PROJECT_NAME)
 
@@ -31,10 +31,10 @@ def no_cfg_project(test):
     @pytest.fixture(scope="function")
     def project(self, tmp_path):
         """
-        Setup a project with default configs to use
-        for testing.
+        Set up a project with default configs
+        to use for testing.
 
-        # Note this fixture is a duplicate of project()
+        Note this fixture is a duplicate of project()
         in test_filesystem_transfer.py fixture
         """
         tmp_path = tmp_path / "test with space"
@@ -53,8 +53,8 @@ def project(self, tmp_path):
     def clean_project_name(self):
         """
         Create an empty project, but ensure no
-        configs already exists, and delete created configs
-        after test.
+        configs already exists, and delete created
+        configs after test.
         """
         project_name = TEST_PROJECT_NAME
         test_utils.delete_project_if_it_exists(project_name)

tests/tests_integration/test_ssh_setup.py

@@ -17,8 +17,8 @@ class TestSSHSetup(BaseTest):
     @pytest.fixture(scope="function")
     def project(test, tmp_path, setup_ssh_container):
         """
-        Make a project as per usual, but now add
-        in test ssh configurations
+        Set up a project with configs for SSH into
+        the test Dockerfile image.
         """
         tmp_path = tmp_path / "test with space"
 
@@ -39,15 +39,10 @@ def test_verify_ssh_central_host_do_not_accept(
         self, capsys, project, input_
     ):
         """
-        Use the main function to test this. Test the sub-function
-        when accepting, because this main function will also
-        call setup ssh key pairs which we don't want to do yet
-
-        This should only accept for "y" so try some random strings
-        including "n" and check they all do not make the connection.
+        Test that host not accepted if input is not "y".
         """
         orig_builtin = copy.deepcopy(builtins.input)
-        builtins.input = lambda _: "y"  # type: ignore
+        builtins.input = lambda _: input_  # type: ignore
 
         project.setup_ssh_connection()
 
@@ -82,8 +77,8 @@ def test_verify_ssh_central_host_accept(self, capsys, project):
 
     def test_generate_and_write_ssh_key(self, project):
         """
-        Check ssh key for passwordless connection is written
-        to file
+        Check ssh key for passwordless connection
+        is written to file.
         """
         path_to_save = project.cfg["local_path"] / "test"
         ssh.generate_and_write_ssh_key(path_to_save)