Skip to content

Commit 6657a82

Browse files
authored
[DOC] Improved consistency of the docstring of an ignored y parameter (scikit-learn#19049)
1 parent 6af03a5 commit 6657a82

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

sklearn/covariance/_empirical_covariance.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ def fit(self, X, y=None):
196196
n_features is the number of features.
197197
198198
y : Ignored
199-
Not used, present for API consistence purpose.
199+
Not used, present for API consistency by convention.
200200
201201
Returns
202202
-------
@@ -226,7 +226,7 @@ def score(self, X_test, y=None):
226226
the data used in fit (including centering).
227227
228228
y : Ignored
229-
Not used, present for API consistence purpose.
229+
Not used, present for API consistency by convention.
230230
231231
Returns
232232
-------

sklearn/covariance/_graph_lasso.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ def fit(self, X, y=None):
386386
Data from which to compute the covariance estimate
387387
388388
y : Ignored
389-
Not used, present for API consistence purpose.
389+
Not used, present for API consistency by convention.
390390
391391
Returns
392392
-------
@@ -696,7 +696,7 @@ def fit(self, X, y=None):
696696
Data from which to compute the covariance estimate
697697
698698
y : Ignored
699-
Not used, present for API consistence purpose.
699+
Not used, present for API consistency by convention.
700700
701701
Returns
702702
-------

sklearn/covariance/_robust_covariance.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -633,7 +633,7 @@ def fit(self, X, y=None):
633633
and `n_features` is the number of features.
634634
635635
y: Ignored
636-
Not used, present for API consistence purpose.
636+
Not used, present for API consistency by convention.
637637
638638
Returns
639639
-------

sklearn/covariance/_shrunk_covariance.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ def fit(self, X, y=None):
136136
and n_features is the number of features.
137137
138138
y: Ignored
139-
not used, present for API consistence purpose.
139+
Not used, present for API consistency by convention.
140140
141141
Returns
142142
-------
@@ -408,7 +408,7 @@ def fit(self, X, y=None):
408408
Training data, where `n_samples` is the number of samples
409409
and `n_features` is the number of features.
410410
y : Ignored
411-
not used, present for API consistence purpose.
411+
Not used, present for API consistency by convention.
412412
413413
Returns
414414
-------
@@ -584,7 +584,7 @@ def fit(self, X, y=None):
584584
Training data, where `n_samples` is the number of samples
585585
and `n_features` is the number of features.
586586
y : Ignored
587-
not used, present for API consistence purpose.
587+
Not used, present for API consistency by convention.
588588
589589
Returns
590590
-------

0 commit comments

Comments
 (0)