8000 DOC Ensures that sklearn.metrics._ranking.auc passes numpydoc validat… · scikit-learn/scikit-learn@f5871a3 · GitHub
[go: up one dir, main page]

Skip to content

Commit f5871a3

Browse files
authored
DOC Ensures that sklearn.metrics._ranking.auc passes numpydoc validation (#23433)
1 parent ac84b2f commit f5871a3

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

sklearn/metrics/_ranking.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,15 @@ def auc(x, y):
5555
Parameters
5656
----------
5757
x : ndarray of shape (n,)
58-
x coordinates. These must be either monotonic increasing or monotonic
58+
X coordinates. These must be either monotonic increasing or monotonic
5959
decreasing.
6060
y : ndarray of shape, (n,)
61-
y coordinates.
61+
Y coordinates.
6262
6363
Returns
6464
-------
6565
auc : float
66+
Area Under the Curve.
6667
6768
See Also
6869
--------

sklearn/tests/test_docstrings.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@
4141
"sklearn.metrics._classification.log_loss",
4242
"sklearn.metrics._plot.det_curve.plot_det_curve",
4343
"sklearn.metrics._plot.precision_recall_curve.plot_precision_recall_curve",
44-
"sklearn.metrics._ranking.auc",
4544
"sklearn.metrics._ranking.coverage_error",
4645
"sklearn.metrics._ranking.dcg_score",
4746
"sklearn.metrics._ranking.label_ranking_average_precision_score",

0 commit comments

Comments
 (0)
0