DOC fix truncated documentation for Series.unstack(), Series. #31260
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
anjalis2112
changed the title
anjalis2112
changed the title
anjalis2112
changed the title
|
No strong objection but I do think this is a little hacky. Do you know where this limitation is being imposed? |
|
The issue here is that, every time a ". " (full stop + space) is encountered, it's presumed to be the end of a one line docstring function description. |
doc/source/user_guide/indexing.rst
Outdated
| @@ -105,7 +105,7 @@ Basics | |||
| ------ | |||
|
|
|||
| As mentioned when introducing the data structures in the :ref:`last section | |||
| <basics>`, the primary function of indexing with ``[]`` (a.k.a. ``__getitem__`` | |||
| <basics>`, the primary function of indexing with ``[]`` (a.k.a ``__getitem__`` | |||
There was a problem hiding this comment.
You don't need to change this in the user guide. The issue only comes up in the first line of docstrings
pandas/core/series.py
Outdated
| @@ -3389,7 +3389,7 @@ def explode(self) -> "Series": | |||
| See Also | |||
| -------- | |||
| Series.str.split : Split string values on specified separator. | |||
| Series.unstack : Unstack, a.k.a. pivot, Series with MultiIndex | |||
| Series.unstack : Unstack, a.k.a pivot, Series with MultiIndex | |||
There was a problem hiding this comment.
also not needed here
pandas/core/series.py
Outdated
| @@ -3432,7 +3432,7 @@ def explode(self) -> "Series": | |||
|
|
|||
| def unstack(self, level=-1, fill_value=None): | |||
| """ | |||
| Unstack, a.k.a. pivot, Series with MultiIndex to produce DataFrame. | |||
| Unstack, a.k.a pivot, Series with MultiIndex to produce DataFrame. | |||
There was a problem hiding this comment.
Maybe just reword this to use "or" instead of "a.k.a.", or wite it in full? "also known as"
There was a problem hiding this comment.
Alright! Will do that
WillAyd
approved these changes
Jan 24, 2020
|
Thanks @anjalis2112 |
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.
fixes #31235
Changed "e.g. " to "e.g., "
Changed "a.k.a. " to "also known as"
This helps avoid the truncation caused in the docstring