more docstring adventures

Author: Genuster

mne/decoding/csp.py

@@ -112,7 +112,7 @@ class CSP(_GEDTransformer):
 
     See Also
     --------
-    mne.preprocessing.Xdawn, SPoC
+    XdawnTransformer, SPoC, SSD
 
     References
     ----------

mne/decoding/xdawn.py

@@ -64,8 +64,7 @@ class XdawnTransformer(_GEDTransformer):
         Defaults to None.
 
         .. versionadded:: 1.10
-    %(rank)s
-        Defaults to "full".
+    %(rank_full)s
 
         .. versionadded:: 1.10
 
@@ -77,6 +76,10 @@ class XdawnTransformer(_GEDTransformer):
         The Xdawn components used to decompose the data for each event type.
     patterns_ : array, shape (n_channels, n_channels)
         The Xdawn patterns used to restore the signals for each event type.
+
+    See Also
+    --------
+    CSP, SPoC, SSD
     """
 
     def __init__(
@@ -89,7 +92,6 @@ def __init__(
         info=None,
         rank="full",
     ):
-        """Init."""
         self.n_components = n_components
         self.signal_cov = signal_cov
         self.reg = reg

mne/utils/docs.py

@@ -3695,6 +3695,7 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
 docdict["rank"] = _rank_base
 docdict["rank_info"] = _rank_base + "\n    The default is ``'info'``."
 docdict["rank_none"] = _rank_base + "\n    The default is ``None``."
+docdict["rank_full"] = _rank_base + "\n    The default is ``'full'``."
 
 docdict["raw_epochs"] = """
 raw : Raw object