DOC

christianbrodbeck · Jan 21, 2021 · bc4cd29 · bc4cd29
1 parent cacd0a1
commit bc4cd29
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 21 deletions.
diff --git a/doc/changes.rst b/doc/changes.rst
@@ -8,16 +8,16 @@ New in 0.34
 
 * API:
 
- - :calls:`plot.Correlation` renamed to :class:`plot.Scatter` with some parameter changes for improved functionality
+ - :class:`plot.Correlation` renamed to :class:`plot.Scatter` with some parameter changes for improved functionality.
 
-* Added:
+* New:
 
  - :func:`boosting`: Option to store TRFs for the different test partitions
-   (``partition_results``).
- - :func:`normalize_in_cells`
- - :func:`load.convert_pickle_protocol`
- - :class:`UTS`: ``unit`` parameter to represent time in units other than seconds
- - :mod:`report` submodule with shortcuts for data summary and visualization
+   (``partition_results`` parameter).
+ - :func:`normalize_in_cells` (see :ref:`exa-compare-topographies`).
+ - :class:`UTS` dimension: ``unit`` parameter to represent time in units other than seconds.
+ - :mod:`report` submodule with shortcuts for data summary and visualization.
+ - :func:`load.convert_pickle_protocol` for compatibility with older Python version.
 
 
 New in 0.33

diff --git a/doc/reference.rst b/doc/reference.rst
@@ -604,7 +604,7 @@ Reports
 .. currentmodule:: eelbrain
 
 The :mod:`report` submodule contains shortcuts for producing data summaries and
-visualizations.
+visualizations. Meant to work in Jupyter notebooks.
 
 .. autosummary::
    :toctree: generated

diff --git a/eelbrain/_experiment/mne_experiment.py b/eelbrain/_experiment/mne_experiment.py
@@ -3401,11 +3401,6 @@ def load_raw(
 
              - :ref:`state-session`: from which session to load raw data
              - :ref:`state-raw`: preprocessing pipeline
-
-        Notes
-        -----
-        Bad channels defined in the raw file itself are ignored in favor of the
-        bad channels in the bad channels file.
         """
         pipe = self._raw[self.get('raw', **kwargs)]
         raw = pipe.load(self.get('subject'), self.get('recording'), add_bads)
@@ -3469,11 +3464,6 @@ def load_raw_stc(
 
              - :ref:`state-session`: from which session to load raw data
              - :ref:`state-raw`: preprocessing pipeline
-
-        Notes
-        -----
-        Bad channels defined in the raw file itself are ignored in favor of the
-        bad channels in the bad channels file.
         """
         raw = self.load_raw(samplingrate=samplingrate, tstart=tstart, tstop=tstop, **kwargs)
         inv, label, mri_sdir, mrisubject, is_scaled, parc = self._prepare_inv(raw, mask, morph)

diff --git a/eelbrain/_table.py b/eelbrain/_table.py
@@ -362,6 +362,10 @@ def melt_ndvar(ndvar, dim=None, cells=None, ds=None, varname=None, labels=None):
     -------
     long_table : Dataset
         Dataset in long format.
+
+    Examples
+    --------
+    See :ref:`exa-compare-topographies`.
     """
     ndvar = asndvar(ndvar, ds=ds)
     if dim is None:

diff --git a/eelbrain/datasets/_simple.py b/eelbrain/datasets/_simple.py
@@ -45,7 +45,7 @@ def _get_continuous(
         ynd: bool = False,
         seed: int = 0,
         xn: int = 0,
-):
+) -> Dataset:
     """Generate continuous data for reverse correlation
 
     Parameters
@@ -62,8 +62,8 @@ def _get_continuous(
 
     Returns
     -------
-    data : dict
-        {:class:`str`: :class:`NDVar`}`` dictionary with simulated data:
+    data
+        Dataset with simulated data:
 
          - ``x1``: random time series
          - ``x2``: two random time series