DOC Ensures plot_precision_recall_curve passes the numpydoc validation#24403
Merged
glemaitre merged 1 commit intoscikit-learn:mainfrom Sep 9, 2022
Merged
DOC Ensures plot_precision_recall_curve passes the numpydoc validation#24403glemaitre merged 1 commit intoscikit-learn:mainfrom
glemaitre merged 1 commit intoscikit-learn:mainfrom
Conversation
036c4db to
945d666
Compare
glemaitre
reviewed
Sep 9, 2022
Member
glemaitre
left a comment
There was a problem hiding this comment.
We have the same issue as for other plotting functions that are deprecated. We need to keep the function in the white list.
| @@ -18,7 +18,6 @@ | |||
| # sklearn.deprecation._update_doc is updating the doc against the numpydoc. | |||
| # This will be fixed with issue: #24328 | |||
| "sklearn.metrics._plot.det_curve.plot_det_curve", | |||
Member
There was a problem hiding this comment.
Suggested change
| "sklearn.metrics._plot.det_curve.plot_det_curve", | |
| "sklearn.metrics._plot.det_curve.plot_det_curve", | |
| # sklearn.deprecation._update_doc is updating the doc against the numpydoc. | |
| # See gh-24328. | |
| "sklearn.metrics._plot.precision_recall_curve.plot_precision_recall_curve", |
|
|
||
| Read more in the :ref:`User Guide <precision_recall_f_measure_metrics>`. | ||
|
|
||
| .. deprecated:: 1.0 |
90f7773 to
013486c
Compare
013486c to
a1fbe77
Compare
Member
|
Thanks. I will merge once the CIs are green. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses #21350
This PR ensures plot_precision_recall_curve is compatible with numpydoc:
What does this implement/fix? Explain your changes.
In #21547, and #22247 it was discussed about removing the depreciated docstrings to avoid the
GL09warning