DOC: Update docs (#12223)

mne-tools · Nov 17, 2023 · d8448e3 · d8448e3
1 parent 5897b81
commit d8448e3
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 7 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -296,8 +296,14 @@ jobs:
       # Build docs
       - run:
           name: make html
+          command: |  # we have -o pipefail in #BASH_ENV so we should be okay
+            set -x
+            PATTERN=$(cat pattern.txt) make -C doc $(cat build.txt) 2>&1 | tee sphinx_log.txt
+      - run:
+          name: Check sphinx log for warnings (which are treated as errors)
+          when: always
           command: |
-            PATTERN=$(cat pattern.txt) make -C doc $(cat build.txt);
+            ! grep "^.* WARNING: .*$" sphinx_log.txt
       - run:
           name: Show profiling output
           when: always

diff --git a/mne/_fiff/meas_info.py b/mne/_fiff/meas_info.py
@@ -1380,7 +1380,7 @@ class Info(dict, SetChannelsMixin, MontageMixin, ContainsMixin):
             The distance limit.
         accept : int
             Whether or not the fit was accepted.
-        coord_trans : instance of Transformation
+        coord_trans : instance of Transform
             The resulting MEG<->head transformation.
 
     * ``hpi_subsystem`` dict:

diff --git a/mne/commands/mne_browse_raw.py b/mne/commands/mne_browse_raw.py
@@ -125,7 +125,8 @@ def run():
     parser.add_option(
         "--clipping",
         dest="clipping",
-        help="Enable trace clipping mode, either 'clamp' or " "'transparent'",
+        help="Enable trace clipping mode. Can be 'clamp', 'transparent', a float, "
+        "or 'none'.",
         default=_RAW_CLIP_DEF,
     )
     parser.add_option(

diff --git a/mne/preprocessing/artifact_detection.py b/mne/preprocessing/artifact_detection.py
@@ -304,8 +304,8 @@ def compute_average_dev_head_t(raw, pos):
 
     Returns
     -------
-    dev_head_t : array of shape (4, 4)
-        New trans matrix using the averaged good head positions.
+    dev_head_t : instance of Transform
+        New ``dev_head_t`` transformation using the averaged good head positions.
     """
     sfreq = raw.info["sfreq"]
     seg_good = np.ones(len(raw.times))

diff --git a/mne/preprocessing/maxwell.py b/mne/preprocessing/maxwell.py
@@ -1973,7 +1973,7 @@ def _update_sss_info(
         The moments that were used.
     st_only : bool
         Whether tSSS only was performed.
-    recon_trans : instance of Transformation
+    recon_trans : instance of Transform
         The reconstruction trans.
     extended_proj : ndarray
         Extended external bases.

diff --git a/mne/utils/config.py b/mne/utils/config.py
@@ -805,7 +805,7 @@ def _get_latest_version(timeout):
     try:
         with urlopen(url, timeout=timeout) as f:  # nosec
             response = json.load(f)
-    except URLError as err:
+    except (URLError, TimeoutError) as err:
         # Triage error type
         if "SSL" in str(err):
             return "SSL error"