docs: numpydoc-validation of ibw/jpk/spm modules

AFM-SPM · May 1, 2024 · c0e4ca9 · c0e4ca9
1 parent 84bfe52
commit c0e4ca9
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 8 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -1,2 +1,5 @@
+# ns-rse/numpydoc-validation ibw/jpk/spm : linting docstrings
+57a3de501051d9710bc2ac196ea695ee4d9118f0
+
 # ns-rse/39-numpydoc-validation : linting docstrings
 09c44841ba185de7ed4729fbe6b1d0f58caeb4bc
diff --git a/topofileformats/ibw.py b/topofileformats/ibw.py
@@ -44,9 +44,9 @@ def load_ibw(file_path: Path | str, channel: str) -> tuple[np.ndarray, float]:
 
     Parameters
     ----------
-    file_path: Path | str
+    file_path : Path | str
         Path to the .ibw file.
-    channel: str
+    channel : str
         The channel to extract from the .ibw file.
 
     Returns

diff --git a/topofileformats/jpk.py b/topofileformats/jpk.py
@@ -42,9 +42,9 @@ def load_jpk(file_path: Path | str, channel: str) -> tuple[np.ndarray, float]:
 
     Parameters
     ----------
-    file_path: Path | str
+    file_path : Path | str
         Path to the .jpk file.
-    channel: str
+    channel : str
         The channel to extract from the .jpk file.
 
     Returns

diff --git a/topofileformats/spm.py b/topofileformats/spm.py
@@ -12,11 +12,14 @@
 
 
 def spm_pixel_to_nm_scaling(filename: str, channel_data: pySPM.SPM.SPM_image) -> float:
-    """Extract pixel to nm scaling from the SPM image metadata.
+    """
+    Extract pixel to nm scaling from the SPM image metadata.
 
     Parameters
     ----------
-    channel_data: pySPM.SPM.SPM_image
+    filename : str
+        File name.
+    channel_data : pySPM.SPM.SPM_image
         Channel data from PySPM.
 
     Returns
@@ -42,7 +45,8 @@ def spm_pixel_to_nm_scaling(filename: str, channel_data: pySPM.SPM.SPM_image) ->
 
 
 def load_spm(file_path: Path | str, channel: str) -> tuple:
-    """Extract image and pixel to nm scaling from the Bruker .spm file.
+    """
+    Extract image and pixel to nm scaling from the Bruker .spm file.
 
     Parameters
     ----------
@@ -51,7 +55,6 @@ def load_spm(file_path: Path | str, channel: str) -> tuple:
     channel : str
         Channel name to extract from the .spm file.
 
-
     Returns
     -------
     tuple(np.ndarray, float)