DOC/FIX indentation in deprecated estimators#16379
Merged
rth merged 1 commit intoscikit-learn:masterfrom Feb 4, 2020
Merged
Conversation
deprecated
Contributor
Author
Member
Thanks! Could you please comment more on what should be changed as for me those two look identical (aside from the dev version banner) :) |
Contributor
Author
|
You have to pay attention to description of the parameters (indices is not in bold and is slightly over-indented, axis is also slightly over-indented). It would also be the case for the description of what is returned if there were more than one element.
… Le 4 févr. 2020 à 19:14, Roman Yurchak ***@***.***> a écrit :
Example: old vs new for sklearn.utils.safe_indexing
Thanks! Could you please comment more on what should be changed please as for me those two look identical (aside from the dev version banner) :)
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
Member
master
This PR
|
thomasjpfan
approved these changes
Feb 4, 2020
deprecated
thomasjpfan
pushed a commit
to thomasjpfan/scikit-learn
that referenced
this pull request
Feb 22, 2020
panpiort8
pushed a commit
to panpiort8/scikit-learn
that referenced
this pull request
Mar 3, 2020
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
3 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.
Reference Issues/PRs
Fixes #15741
What does this implement/fix? Explain your changes.
This small PR adds 4 whitespaces when the docstring is updated. Why? Because functions and classes are indented, so are their docstrings, thus a new paragraph must start with 4 whitespaces.
\tdoes not work as good, because there are really 4 whitespaces in docstrings.Any other comments?
I did not try on scikit-learn repository but on a project of mine (so that the documentation builds faster), I will try to have a look at the documentation from Circle CI to see if this works as expected.