DOC: update shared_docs to clarify groupby with lists #44569
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
|
Hello @arushi-08! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found: There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻 Comment last updated at 2021-11-24 05:22:52 UTC |
phofl
reviewed
Nov 22, 2021
pandas/core/shared_docs.py
Outdated
| aligned; see ``.align()`` method). If an ndarray is passed, the | ||
| aligned; see ``.align()`` method). If a list (of acceptable items. | ||
| See the `groupby user guide | ||
| <https://pandas.pydata.org/pandas-docs/stable/user_guide/groupby.html#splitting-an-object-into-groups>`) |
There was a problem hiding this comment.
Could you move See the `groupby user guide <https://pandas.pydata.org/pandas-docs/stable/user_guide/groupby.html#splitting-an-object-into-groups>`) after passed? Not sure if we need the acceptable items part
There was a problem hiding this comment.
Thank you for the input. I have updated doc string.
|
thanks @arushi-08 |
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.
Following @rhshadrach 's and @asishm 's suggestion, this PR modifies groupby docstring.