Simplify some docstrings in h5ebsd reader

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
pyxem · hakonanes · May 29, 2023 · May 28, 2023 · May 28, 2023 · May 28, 2023
commit 735cf46a1f3ff4731632f635b64e86a17829b5fb
diff --git a/kikuchipy/io/plugins/_h5ebsd.py b/kikuchipy/io/plugins/_h5ebsd.py
@@ -45,8 +45,7 @@ def _hdf5group2dict(
     dictionary
         To fill dataset values into.
     recursive
-        Whether to add subgroups to ``dictionary`` (default is
-        ``False``).
+        Whether to add subgroups to ``dictionary`` (default is False).
     data_dset_names
         List of names of HDF5 data sets with data to not read.
 
@@ -171,10 +170,10 @@ def check_file(self):
         ------
         IOError
             If there are no datasets in the top group named
-            ``"manufacturer"`` and ``"version"``, or if there are no
-            groups in the top group containing the datasets
-            ``"EBSD/Data"`` and ``"EBSD/Header"``, or if there is no
-            reader for the file ``"manufacturer"``.
+            "manufacturer" and "version", or if there are no groups in
+            the top group containing the datasets
+            "EBSD/Data" and "EBSD/Header", or if there is no reader for
+            the file "manufacturer".
         """
         error = None
         if self.manufacturer is None or self.version is None:
@@ -291,7 +290,7 @@ def get_data(
             Output shape of pattern array, (ny, nx, sy, sx) = (
             map rows, map columns, pattern rows, pattern columns).
         lazy
-            Whether to read dataset lazily (default is ``False``).
+            Whether to read dataset lazily (default is False).
         indices
             Mapping from pattern entry in the file to the 2D map, only
             used in the Bruker Nano reader.
@@ -361,10 +360,10 @@ def get_axes_list(data_shape: tuple, data_scale: tuple) -> List[dict]:
         Parameters
         ----------
         data_shape
-            4D shape of pattern array, ``(ny, nx, sy, sx)`` = (
-            map rows, map columns, pattern rows, pattern columns).
+            4D shape of pattern array, (ny, nx, sy, sx) = ( map rows,
+            map columns, pattern rows, pattern columns).
         data_scale
-            Map scale and detector pixel size, ``(dy, dx, px_size)``.
+            Map scale and detector pixel size, (dy, dx, px_size).
 
         Returns
         -------
@@ -454,15 +453,15 @@ def read(
             Name or a list of names of the desired top HDF5 group(s). If
             not given, the first scan group is returned.
         lazy
-            Read dataset lazily (default is ``False``). If ``False``,
-            the file is closed after reading.
+            Read dataset lazily (default is False). If False, the file
+            is closed after reading.
 
         Returns
         -------
         scan_list
-            List of dictionaries with keys ``"axes"``, ``"data"``,
-            ``"metadata"``, ``"original_metadata"``, ``"detector"``,
-            (possibly) ``"static_background"``, and ``"xmap"``.
+            List of dictionaries with keys "axes", "data", "metadata",
+            "original_metadata", "detector", (possibly)
+            "static_background", and "xmap".
         """
         scan_dict_list = []
         for scan in self.get_desired_scan_groups(group_names):
@@ -482,15 +481,14 @@ def scan2dict(self, group: h5py.Group, lazy: bool = False) -> dict:
         group
             HDF5 group with patterns.
         lazy
-            Read dataset lazily (default is ``False``).
+            Read dataset lazily (default is False).
 
         Returns
         -------
         scan_dict
-            Dictionary with keys ``"axes"``, ``"data"``, ``"metadata"``,
-            ``"original_metadata"``, ``"detector"``,
-            ``"static_background"``, and ``"xmap"``. This dictionary can
-             be passed as keyword arguments to create an
-             :class:`~kikuchipy.signals.EBSD` signal.
+            Dictionary with keys "axes", "data", "metadata",
+            "original_metadata", "detector", "static_background", and
+            "xmap". This dictionary can be passed as keyword arguments
+            to create an :class:`~kikuchipy.signals.EBSD` signal.
         """
         return NotImplemented  # pragma: no cover