Skip to content

DOC: Clean sort_values and sort_index docstrings #24843

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 12 commits into from
Jan 27, 2019
Merged

DOC: Clean sort_values and sort_index docstrings #24843

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0f5e99f
DOC: Clean sort_values and sort_index docstrings
Jan 20, 2019
73a911e
Clean docstrings
Jan 22, 2019
b02d672
Fix PEP8 line length
Jan 22, 2019
794aae1
Capitalize True
Jan 24, 2019
5063294
Fix PEP8 in example
Jan 24, 2019
171acfd
Use bool not boolean
Jan 24, 2019
a2fbe01
Add periods to descriptions
Jan 24, 2019
2f8c8ae
Fix docstring errors
Jan 24, 2019
612311e
Update pandas/core/generic.py
WillAyd Jan 25, 2019
cc58933
Update pandas/core/generic.py
WillAyd Jan 25, 2019
6a40a22
Edit sort_index returns section
Jan 25, 2019
75750da
Update sort_values docstring
Jan 26, 2019
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
Prev Previous commit
Next Next commit
Fix docstring errors
  • Loading branch information
Daniel Saxton committed Jan 24, 2019
commit 2f8c8aebbee821759d91885f9860ec04bfa5747c
12 changes: 8 additions & 4 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ def set_axis(self, labels, axis=0, inplace=None):
The axis to update. The value 0 identifies the rows, and 1
identifies the columns.

inplace : boolean, default None
inplace : bool, default None
Whether to return a new %(klass)s instance.

.. warning::
Expand Down Expand Up @@ -3989,7 +3989,8 @@ def sort_values(self, by=None, axis=0, ascending=True, inplace=False,

Returns
-------
sorted_obj : %(klass)s
sorted_obj : %(klass)s or None
An object of same type as caller if inplace=False, None otherwise.

Examples
--------
Expand Down Expand Up @@ -4061,7 +4062,9 @@ def sort_index(self, axis=0, level=None, ascending=True, inplace=False,

Parameters
----------
axis : %(axes)s to direct sorting
axis : {0 or 'index', 1 or 'columns'}, default 0
The axis along which to sort. The value 0 identifies the rows,
and 1 identifies the columns.
level : int or level name or list of ints or list of level names
If not None, sort on values in specified index level(s).
ascending : bool, default True
Expand All @@ -4082,7 +4085,8 @@ def sort_index(self, axis=0, level=None, ascending=True, inplace=False,

Returns
-------
sorted_obj : %(klass)s
sorted_obj : %(klass)s or None
An object of same type as caller if inplace=False, None otherwise.
"""
inplace = validate_bool_kwarg(inplace, 'inplace')
axis = self._get_axis_number(axis)
Expand Down