Fix docstring linting errors in UliEngineering/Utils/ files

Author: Uli Köhler

UliEngineering/Utils/NumPy.py

@@ -12,7 +12,7 @@ def numpy_resize_insert(arr, val, index, growth_factor=1.5, min_growth=1000, max
     """
     Append a value to a 1D numpy array. Resize dynamically if required.
     Returns the new array (which may be the same as the old array).
-    No resize is performed if the array is already large enough
+    No resize is performed if the array is already large enough.
 
     Supports non-continous insertion of values (i.e. index must not grow monotonically).
 
@@ -64,7 +64,7 @@ def invert_bijection(arr):
     returned by np.argsort().
 
     For each value x in the given array at index i,
-    the new array will
+    the new array will have the value i at index x.
 
     Preconditions (not checked):
         - All elements must be >= 0 and < arr.size
@@ -97,7 +97,7 @@ def apply_pairwise_1d(valuesA, valuesB, fn, dtype=float):
     """
     Given two 1d arrays, generates a 2d matrix
     containing at any coordinate [x,y] the value of fn(valuesA[x], valuesB[y]).
-    If valu
+    If valuesB is None, valuesA is used for both arrays.
 
     The input values do not neccessarily have to be numbers and can be
     non-uniform throughout the input list data type,
@@ -130,7 +130,7 @@ def ngrams(arr, n, closed=False):
     """
     Yield ngrams of subsequent entries from an arbitrarily-shaped array.
     For example, with arr=[1,2,3,4,5,6]
-    and n=2, yields [[1,2][2,3],[3,4],[4,5],[5,6]]
+    and n=2, yields [[1,2][2,3],[3,4],[4,5],[5,6]].
     if closed=False or [[1,2][2,3],[3,4],[4,5],[5,6],[6,1]] if closed=True.
 
     For n=2, this function behaves similarly to

UliEngineering/Utils/String.py

@@ -36,7 +36,7 @@ def suffix_list(s: str) -> List[str]:
     Return all suffixes for a string, including the string itself,
     in order of ascending length.
 
-    Example: "foobar" => ['r', 'ar', 'bar', 'obar', 'oobar', 'foobar']
+    Example: "foobar" => ['r', 'ar', 'bar', 'obar', 'oobar', 'foobar'].
     """
     return [s[-i:] for i in range(1, len(s) + 1)]
 

UliEngineering/Utils/Temporary.py

@@ -9,7 +9,7 @@
 
 class AutoDeleteTempfileGenerator:
     """
-    A wrapper for temporary files and directories that are automatically automatically
+    A wrapper for temporary files and directories that are automatically
     deleted once this class is deleted or deleteAll() is called.
 
     This is not comparable to tempfile.TemporaryFile as the TemporaryFile instance
@@ -29,30 +29,30 @@ def __del__(self):
         self.delete_all()
 
     def mkstemp(self, suffix='', prefix='tmp', directory=None):
-        """Same as tempfile.mktemp(), but creates a file managed by this class instance"""
+        """Same as tempfile.mktemp(), but creates a file managed by this class instance."""
         handle, fname = tempfile.mkstemp(suffix, prefix, directory)
         self.tempfiles.append(fname)
         return (handle, fname)
 
     def mkftemp(self, suffix='', prefix='tmp', directory=None, mode='w'):
         """
         Wrapper for self.mkstemp() that opens the OS-level file handle
-        as a normal Python handle with the given mode
+        as a normal Python handle with the given mode.
         """
         handle, fname = self.mkstemp(suffix, prefix, directory)
         handle = os.fdopen(handle, mode)
         return (handle, fname)
 
     def mkdtemp(self, suffix='', prefix='tmp', directory=None):
-        """Same as tempfile.mkdtemp(), but creates a file managed by this class instance"""
+        """Same as tempfile.mkdtemp(), but creates a file managed by this class instance."""
         fname = tempfile.mkdtemp(suffix, prefix, directory)
         self.tempdirs.append(fname)
         return fname
 
     def delete_all(self):
         """
         Force-delete all files and directories created by this instance.
-        The class instance may be used without restriction after this call
+        The class instance may be used without restriction after this call.
         """
         #
         for filename in self.tempfiles:

UliEngineering/Utils/ZIP.py

@@ -9,20 +9,20 @@
 
 def create_zip_from_directory(zippath, directory, include_rootdir=True):
     """
-    Create a ZIP file from a directory that exist
+    Create a ZIP file from a directory that exists
     on the filesystem. Adds all files recursively,
     naming them correctly.
 
     Parameters
     ----------
     zippath : path-like
-        The path of the ZIP file to write
+        The path of the ZIP file to write.
     directory : path-like
-        The directory to compress
+        The directory to compress.
     include_rootdir : bool
-        if True, the basename of the directory is prepended
+        If True, the basename of the directory is prepended
         to each filename in the ZIP (i.e. when running unzip
-        on the ZIP, one directory is extracted)
+        on the ZIP, one directory is extracted).
     """
     basename = os.path.basename(directory)
     with zipfile.ZipFile(zippath, mode="w") as zipout:
@@ -50,18 +50,19 @@ def read_from_zip(zippath, filepaths, binary=True):
     Parameters
     ----------
     zippath : path-like
-        The path of the ZIP file
+        The path of the ZIP file.
     filepath : str or iterable of strings
-        The path of the file inside the ZIP
-        Multiple paths allowed (=> list is returned)
+        The path of the file inside the ZIP.
+        Multiple paths allowed (=> list is returned).
     binary : bool
         If True, returns a io.BytesIO().
-        If False, returns a io.StringIO()
+        If False, returns a io.StringIO().
 
     Returns
     -------
-    If filepath is a string, a single file-like object (in-memory).
-    If filepath is any other iterable, a list of file-like in-memory objs.
+    io.BytesIO or io.StringIO or list
+        If filepath is a string, a single file-like object (in-memory).
+        If filepath is any other iterable, a list of file-like in-memory objs.
     """
     iof = io.BytesIO if binary else io.StringIO
     # Handle single file using the same code as multiple files