Skip to content

DOC: Fix PR06 errors in Series docstrings (#28253) #28288

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 2 commits into from
Sep 16, 2019
Merged

DOC: Fix PR06 errors in Series docstrings (#28253) #28288

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
baf5df4
DOC: Fix PR06 errors in Series docstrings (#28253)
danielplawrence Sep 2, 2019
a99ef99
DOC: Update param descriptions for axis in NDFrame methods (#28253)
danielplawrence Sep 14, 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
12 changes: 6 additions & 6 deletions pandas/core/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1289,17 +1289,17 @@ def value_counts(

Parameters
----------
normalize : boolean, default False
normalize : bool, default False
If True then the object returned will contain the relative
frequencies of the unique values.
sort : boolean, default True
sort : bool, default True
Sort by frequencies.
ascending : boolean, default False
ascending : bool, default False
Sort in ascending order.
bins : integer, optional
bins : int, optional
Rather than count values, group them into half-open bins,
a convenience for ``pd.cut``, only works with numeric data.
dropna : boolean, default True
dropna : bool, default True
Don't include counts of NaN.

Returns
Expand Down Expand Up @@ -1496,7 +1496,7 @@ def memory_usage(self, deep=False):
size_hint="",
sort=textwrap.dedent(
"""\
sort : boolean, default False
sort : bool, default False
Sort `uniques` and shuffle `labels` to maintain the
relationship.
"""
Expand Down
30 changes: 16 additions & 14 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2313,7 +2313,7 @@ def to_json(
floating point values.
force_ascii : bool, default True
Force encoded string to be ASCII.
date_unit : string, default 'ms' (milliseconds)
date_unit : str, default 'ms' (milliseconds)
The time unit to encode to, governs timestamp and ISO8601
precision. One of 's', 'ms', 'us', 'ns' for second, millisecond,
microsecond, and nanosecond respectively.
Expand Down Expand Up @@ -2533,7 +2533,7 @@ def to_msgpack(self, path_or_buf=None, encoding="utf-8", **kwargs):

Parameters
----------
path : string File path, buffer-like, or None
path : str (file path), buffer-like, or None
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
path : str (file path), buffer-like, or None
path : str, filepath, buffer-like, or None

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since neither 'file path' nor 'filepath' are listed as types here, I've removed this and added a little clarification below.

if None, return generated bytes
append : bool whether to append to an existing msgpack
(default is False)
Expand Down Expand Up @@ -4621,8 +4621,9 @@ def filter(self, items=None, like=None, regex=None, axis=None):
Keep labels from axis for which "like in label == True".
regex : str (regular expression)
Keep labels from axis for which re.search(regex, label) == True.
axis : int or string axis name
The axis to filter on. By default this is the info axis,
axis : int or str
Copy link
Member

Choose a reason for hiding this comment

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

There is a particular convention for axis you can use

axis : {0 or ‘index’, 1 or ‘columns’, None}, default None

From the docs:

https://pandas.pydata.org/pandas-docs/stable/development/contributing_docstring.html#parameter-types

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in a99ef99

The axis to filter on, expressed either as an index (int)
or axis name (str). By default this is the info axis,
'index' for Series, 'columns' for DataFrame.

Returns
Expand Down Expand Up @@ -4855,7 +4856,7 @@ def sample(
random_state : int or numpy.random.RandomState, optional
Seed for the random number generator (if int), or numpy RandomState
object.
axis : int or string, optional
axis : int or str, optional
Copy link
Member

Choose a reason for hiding this comment

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

same thing here for axis

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in a99ef99

Axis to sample. Accepts axis number or name. Default is stat axis
for given data type (0 for Series and DataFrames).

Expand Down Expand Up @@ -8462,7 +8463,7 @@ def first(self, offset):

Parameters
----------
offset : string, DateOffset, dateutil.relativedelta
offset : str, DateOffset, dateutil.relativedelta

Returns
-------
Expand Down Expand Up @@ -8525,7 +8526,7 @@ def last(self, offset):

Parameters
----------
offset : string, DateOffset, dateutil.relativedelta
offset : str, DateOffset, dateutil.relativedelta

Returns
-------
Expand Down Expand Up @@ -9133,7 +9134,7 @@ def _where(

Parameters
----------
cond : boolean %(klass)s, array-like, or callable
cond : bool %(klass)s, array-like, or callable
Where `cond` is %(cond)s, keep the original value. Where
%(cond_rev)s, replace with corresponding value from `other`.
If `cond` is callable, it is computed on the %(klass)s and
Expand Down Expand Up @@ -9440,9 +9441,10 @@ def tshift(self, periods=1, freq=None, axis=0):
----------
periods : int
Number of periods to move, can be positive or negative
freq : DateOffset, timedelta, or time rule string, default None
Increment to use from the tseries module or time rule (e.g. 'EOM')
axis : int or basestring
freq : DateOffset, timedelta, or str, default None
Increment to use from the tseries module
or time rule expressed as a string (e.g. 'EOM')
axis : int or str
Copy link
Member

Choose a reason for hiding this comment

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

and finally here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in a99ef99

Corresponds to the axis that contains the Index

Returns
Expand Down Expand Up @@ -9500,9 +9502,9 @@ def truncate(self, before=None, after=None, axis=None, copy=True):

Parameters
----------
before : date, string, int
before : date, str, int
Truncate all rows before this index value.
after : date, string, int
after : date, str, int
Truncate all rows after this index value.
axis : {0 or 'index', 1 or 'columns'}, optional
Axis to truncate. Truncates the index (rows) by default.
Expand Down Expand Up @@ -10311,7 +10313,7 @@ def _check_percentile(self, q):
How to handle NAs before computing percent changes.
limit : int, default None
The number of consecutive NAs to fill before stopping.
freq : DateOffset, timedelta, or offset alias string, optional
freq : DateOffset, timedelta, or str, optional
Increment to use from time series API (e.g. 'M' or BDay()).
**kwargs
Additional keyword arguments are passed into
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1788,7 +1788,7 @@ def to_sparse(self, kind="block", fill_value=None):

Parameters
----------
kind : {'block', 'integer'}, default 'block'
kind : {'block', 'int'}, default 'block'
fill_value : float, defaults to NaN (missing)
Value to use for filling NaN values.

Expand Down
2 changes: 1 addition & 1 deletion pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1145,7 +1145,7 @@ def kde(self, bw_method=None, ind=None, **kwargs):
'scott', 'silverman', a scalar constant or a callable.
If None (default), 'scott' is used.
See :class:`scipy.stats.gaussian_kde` for more information.
ind : NumPy array or integer, optional
ind : NumPy array or int, optional
Evaluation points for the estimated PDF. If None (default),
1000 equally spaced points are used. If `ind` is a NumPy array, the
KDE is evaluated at the points passed. If `ind` is an integer,
Expand Down