FIX sphinx formatting in load_boston #21185
Merged
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
ogrisel
commented
Sep 28, 2021
|
Ok the formatting is fixed. The content of the docstring is redundant with the deprecation warning and both are displayed in the sphinx rendering. I am not sure what we can do about it. I think this is good enough the way it is. |
|
Thanks @ogrisel |
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Oct 23, 2021
glemaitre
pushed a commit
that referenced
this pull request
Oct 25, 2021
samronsin
pushed a commit
to samronsin/scikit-learn
that referenced
this pull request
Nov 30, 2021
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.
Follow-up for: #16155.
I suspect this is indirectly causing the lack of rendering of subsequent indented code snippets in:
https://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_boston.html?highlight=load_boston#sklearn.datasets.load_boston
Let's check on the rendered HTML artifact of this PR.
This would probably deserve a backport to 1.0.X to fix the online doc for this function which was deprecated in 1.0.0.