DOC: make return type documentation of series methods consistent #35409 #36862
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
|
Fix docstrings associated with Series methods for now. Once it passes review, I'll start working on other docstring fixes in the same way. |
ivanovmg
reviewed
Oct 4, 2020
ivanovmg
reviewed
Oct 4, 2020
pandas/core/arrays/categorical.py
Outdated
| @@ -917,7 +916,8 @@ def reorder_categories(self, new_categories, ordered=None, inplace=False): | |||
|
|
|||
| Returns | |||
| ------- | |||
| cat : Categorical with reordered categories or None if inplace. | |||
| cat : Categprocal or None | |||
There was a problem hiding this comment.
Thank you. Done.
I start working on other docstring fixes in the same way.
There was a problem hiding this comment.
Note that CI Checks complains about missing dots at the end of return statement.
6818:RT05:pandas.DataFrame.interpolate:Return value description should finish with "."
There are several of such errors.
There was a problem hiding this comment.
I'm sorry for all the mistakes. Thank you for pointing that out. Done.
ivanovmg
approved these changes
Oct 5, 2020
|
would love to get a hacktoberfest tag if possible. #36837 |
|
cc @simonjayhawkins ok with the text? |
|
Thanks @junjunjunk! Very nice. |
kesmit13
pushed a commit
to kesmit13/pandas
that referenced
this pull request
Nov 2, 2020
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.
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diff