[DOC] Make SSD fit docstring clearer (#12664)

mne-tools · Jun 14, 2024 · 4da96f4 · 4da96f4
1 parent d0eff79
commit 4da96f4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/doc/changes/devel/12664.other.rst b/doc/changes/devel/12664.other.rst
@@ -0,0 +1 @@
+Improved clarity of parameter documentation for `mne.decoding.SSD.fit`, by `Thomas Binns`_.
diff --git a/mne/decoding/ssd.py b/mne/decoding/ssd.py
@@ -177,8 +177,8 @@ def fit(self, X, y=None):
             The input data from which to estimate the SSD. Either 2D array
             obtained from continuous data or 3D array obtained from epoched
             data.
-        y : None | array, shape (n_samples,)
-            Used for scikit-learn compatibility.
+        y : None
+            Ignored; exists for compatibility with scikit-learn pipelines.
 
         Returns
         -------
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Improved clarity of parameter documentation for `mne.decoding.SSD.fit`, by `Thomas Binns`_.