DOC Add "See Also" reference to ValidationCurveDisplay in validation_curve docstring #31314
Conversation
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
|
@TheAyos this PR includes unrelated changes. Can you please update it to only include the change in the docstring? |
ogrisel
reviewed
May 6, 2025
There was a problem hiding this comment.
In addition to the unrelated changes, here is some feedback to fix the problems found by looking at the CI report.
First clicking on the failures, in those reports to reach the logs you can see the following error message:
E - GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, See Also, Notes, Examples
Please put the "See also" section after the "Returns" section to fix the failing tests.
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
|
Well, I guess we can safely merge and iterate if needed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reference Issues/PRs
Aims to solve PR #31302.
What does this implement/fix? Explain your changes.
Updated the docstring of validation_curve, added "See Also" references to ValidationCurveDisplay.
Any other comments?
N/A.