Update doc strings.

Author: andrewtarzia

tests/molecular/molecules/building_block/test_get_core_atom_ids.py

@@ -12,9 +12,6 @@ def test_get_core_atom_ids(case_data: CaseData) -> None:
             A test case. Holds the building block to test and the correct
             core atom ids.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     for id1, id2 in it.zip_longest(

tests/molecular/molecules/building_block/test_get_functional_groups.py

@@ -15,9 +15,6 @@ def test_get_functional_groups(case_data: CaseData) -> None:
             A test case. Holds the building block to test and the correct
             functional groups.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_get_functional_groups(
@@ -40,9 +37,6 @@ def _test_get_functional_groups(
         functional_groups:
             The correct functional groups.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     for fg1, fg2 in it.zip_longest(

tests/molecular/molecules/building_block/test_get_num_functional_groups.py

@@ -10,10 +10,6 @@ def test_get_num_functional_groups(case_data: CaseData) -> None:
             A test case. Holds the building block to test and the correct
             functional groups.
 
-    Returns:
-        :class:`NoneType`
-
-
     """
 
     assert case_data.building_block.get_num_functional_groups() == len(

tests/molecular/molecules/building_block/test_get_placer_ids.py

@@ -13,9 +13,6 @@ def test_get_placer_ids(case_data: CaseData) -> None:
             A test case. Holds the building block to test and the
             correct placer ids.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_get_placer_ids(
@@ -38,9 +35,6 @@ def _test_get_placer_ids(
         placer_ids:
             The correct placer ids.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     for placer1, placer2 in it.zip_longest(

tests/molecular/molecules/building_block/test_repr.py

@@ -11,9 +11,6 @@ def test_repr(case_data: CaseData) -> None:
         case_data:
             A test case. Holds the building block to test.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_repr(
@@ -33,9 +30,6 @@ def _test_repr(building_block: stk.BuildingBlock, known_repr: str) -> None:
         known_repr:
             The correct representation.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     print(building_block.__repr__(), known_repr)

tests/molecular/molecules/building_block/test_with_functional_groups.py

@@ -23,9 +23,6 @@ def test_with_functional_groups(
             Takes a single parameter, `building_block` and returns the
             `functional_groups` parameter to use for this test.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     # Save clone to check immutability.
@@ -52,9 +49,6 @@ def _test_with_functional_groups(
         functional_groups:
             The functional groups the new building block should hold.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     new = building_block.with_functional_groups(functional_groups)

tests/molecular/writers/mdl_mol/test_to_string.py

@@ -11,9 +11,6 @@ def test_to_string(case_data: CaseData) -> None:
         case_data:
             A test case.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_to_string(
@@ -41,9 +38,6 @@ def _test_to_string(
         string:
             The expected output string.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     test_string = writer.to_string(molecule)

tests/molecular/writers/mdl_mol/test_write.py

@@ -15,9 +15,6 @@ def test_write(case_data: CaseData, tmp_path: pathlib.Path) -> None:
         tmp_path:
             Path to temporary directory.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_write(
@@ -50,9 +47,6 @@ def _test_write(
         file_path:
             Path to temporary file.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     writer.write(molecule, file_path)

tests/molecular/writers/pdb/test_to_string.py

@@ -11,9 +11,6 @@ def test_to_string(case_data: CaseData) -> None:
         case_data:
             A test case.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_to_string(
@@ -46,9 +43,6 @@ def _test_to_string(
         periodic_info:
             Periodic information.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     test_string = writer.to_string(

tests/molecular/writers/pdb/test_write.py

@@ -15,9 +15,6 @@ def test_write(case_data: CaseData, tmp_path: pathlib.Path) -> None:
         tmp_path:
             Path to temporary directory.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_write(
@@ -55,9 +52,6 @@ def _test_write(
         periodic_info:
             Periodic information.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     writer.write(

tests/molecular/writers/turbomole/test_to_string.py

@@ -11,9 +11,6 @@ def test_to_string(case_data: CaseData) -> None:
         case_data:
             A test case.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_to_string(
@@ -46,9 +43,6 @@ def _test_to_string(
         periodic_info:
             Periodic information.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     test_string = writer.to_string(

tests/molecular/writers/turbomole/test_write.py

@@ -15,9 +15,6 @@ def test_write(case_data: CaseData, tmp_path: pathlib.Path) -> None:
         tmp_path:
             Path to temporary directory.
 
-    Returns:
-        :class:`NoneType`
-
     """
     _test_write(
         molecule=case_data.molecule,
@@ -54,9 +51,6 @@ def _test_write(
         periodic_info:
             Periodic information.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     writer.write(

tests/molecular/writers/xyz/test_to_string.py

@@ -11,9 +11,6 @@ def test_to_string(case_data: CaseData) -> None:
         case_data:
             A test case.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_to_string(
@@ -41,9 +38,6 @@ def _test_to_string(
         string:
             The expected output string.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     test_string = writer.to_string(molecule)

tests/molecular/writers/xyz/test_write.py

@@ -15,9 +15,6 @@ def test_write(case_data: CaseData, tmp_path: pathlib.Path) -> None:
         tmp_path:
             Path to temporary directory.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     _test_write(
@@ -50,9 +47,6 @@ def _test_write(
         file_path:
             Path to temporary file.
 
-    Returns:
-        :class:`NoneType`
-
     """
 
     writer.write(molecule, file_path)