Skip to content
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

Jump to bottom

Fixed docstring errors in pandas.period range and pandas.PeriodIndex #28756

Merged
merged 3 commits into from
Oct 2, 2019
Merged

Fixed docstring errors in pandas.period range and pandas.PeriodIndex #28756

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8550ec3
Minor fixes for docstring errors in pandas.period_range
anirudnits Oct 2, 2019
7bc7357
Minor fixes for docstring errors in pandas.period_range_and_PeriodIndex
anirudnits Oct 2, 2019
f0fd8d7
Minor fixes for docstring errors in pandas.period_range_and_PeriodIndex
anirudnits Oct 2, 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
14 changes: 7 additions & 7 deletions pandas/core/indexes/period.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ class PeriodIndex(DatetimeIndexOpsMixin, Int64Index, PeriodDelegateMixin):

Parameters
----------
data : array-like (1d integer np.ndarray or PeriodArray), optional
data : array-like (1d int np.ndarray or PeriodArray), optional
Optional period-like data to construct index with
copy : bool
Make a copy of input ndarray
freq : string or period object, optional
freq : str or period object, optional
One of pandas period strings or corresponding objects
start : starting value, period-like, optional
If data is None, used as the start point in generating regular
Expand Down Expand Up @@ -1001,18 +1001,18 @@ def period_range(start=None, end=None, periods=None, freq=None, name=None):

Parameters
----------
start : string or period-like, default None
start : str or period-like, default None
Left bound for generating periods
end : string or period-like, default None
end : str or period-like, default None
Right bound for generating periods
periods : integer, default None
periods : int, default None
Number of periods to generate
freq : string or DateOffset, optional
freq : str or DateOffset, optional
Frequency alias. By default the freq is taken from `start` or `end`
if those are Period objects. Otherwise, the default is ``"D"`` for
daily frequency.

name : string, default None
name : str, default None
Name of the resulting PeriodIndex

Returns
Expand Down