Skip to content

DOC fix truncated documentation for Series.unstack(), Series. #31260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 24, 2020
Merged

DOC fix truncated documentation for Series.unstack(), Series. #31260

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
32b9f47
changed .
anjalis912 Jan 23, 2020
da996f4
Update indexing.rst
anjalis912 Jan 24, 2020
8e0f2b7
Update io.rst
anjalis912 Jan 24, 2020
31f5575
Update reshaping.rst
anjalis912 Jan 24, 2020
9c1d804
DOC: changed '. ' to avoid truncation.
anjalis912 Jan 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/user_guide/indexing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to change this in the user guide. The issue only comes up in the first line of docstrings

for those familiar with implementing class behavior in Python) is selecting out
lower-dimensional slices. The following table shows return type values when
indexing pandas objects with ``[]``:
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The pandas I/O API is a set of top level ``reader`` functions accessed like
CSV & text files
----------------

The workhorse function for reading text files (a.k.a. flat files) is
The workhorse function for reading text files (a.k.a flat files) is
:func:`read_csv`. See the :ref:`cookbook<cookbook.csv>` for some advanced strategies.

Parsing options
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/reshaping.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,7 @@ we can also pass in ``sum``.
values='val0', index='row', columns='col', aggfunc='sum', fill_value=0)

Another aggregation we can do is calculate the frequency in which the columns
and rows occur together a.k.a. "cross tabulation". To do this, we can pass
and rows occur together a.k.a "cross tabulation". To do this, we can pass
``size`` to the ``aggfunc`` parameter.

.. ipython:: python
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7371,7 +7371,7 @@ def at_time(
self: FrameOrSeries, time, asof: bool_t = False, axis=None
) -> FrameOrSeries:
"""
Select values at particular time of day (e.g. 9:30AM).
Select values at particular time of day (e.g., 9:30AM).

Parameters
----------
Expand Down
4 changes: 2 additions & 2 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also not needed here

to produce DataFrame.
DataFrame.melt : Unpivot a DataFrame from wide format to long format.
DataFrame.explode : Explode a DataFrame from list-like
Expand Down Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just reword this to use "or" instead of "a.k.a.", or wite it in full? "also known as"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright! Will do that

The level involved will automatically get sorted.

Parameters
Expand Down