docs: doctest format for example in docstring

Re-writing example in docstring to use [doctest format](https://numpydoc.readthedocs.io/en/latest/format.html#examples).
AFM-SPM · May 1, 2024 · 2d8dcf1 · 2d8dcf1
1 parent 26598d2
commit 2d8dcf1
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/topofileformats/spm.py b/topofileformats/spm.py
@@ -66,9 +66,11 @@ def load_spm(file_path: Path | str, channel: str) -> tuple:
 
     Examples
     --------
-    ```python
-    from topofileformats.spm import load_spm
-    image, pixel_to_nm = load_spm(file_path="path/to/file.spm", channel="Height")
+    Load the image and pixel to nanometre scaling factor, available channels are 'Height', 'ZSensor' and 'Height
+    Sensor'.
+
+    >>> from topofileformats.spm import load_spm
+    >>> image, pixel_to_nm = load_spm(file_path="path/to/file.spm", channel="Height")
     ```
     """
     logger.info(f"Loading image from : {file_path}")