Docstring fix

{{cookiecutter.project_name}}/config/__init__.py

@@ -0,0 +1 @@
+"""Config files to be used with hydra."""

{{cookiecutter.project_name}}/src/scripts/{{'' if cookiecutter.dependency_manager != 'pip' else 'freeze_dependencies.py'}}

@@ -10,6 +10,7 @@ class TomlSplitListsEncoder(toml.TomlEncoder):
     """Custom encoder to split lists into multiple lines."""
 
     def dump_list(self, v) -> str:
+        """Docstring to shut up ruff."""
         if len(v) == 0:
             return "[]"
         else:
@@ -20,6 +21,17 @@ class TomlSplitListsEncoder(toml.TomlEncoder):
             return retval
 
     def dump_value(self, v) -> str:
+        """Convert an object to a string representation.
+
+        In case the object is a string then we ensure that newlines are preserved.
+
+        Args:
+            v:
+                The object to be dumped.
+
+        Returns:
+            A string representation of the object.
+        """
         dump = super().dump_value(v)
         if isinstance(v, str) and "\\n" in dump:
             dump = dump.replace("\\n", "\n")

{{cookiecutter.project_name}}/tests/test_dummy.py

@@ -2,4 +2,5 @@
 
 
 def test_dummy() -> None:
+    """Dummy test function."""
     assert True