Skip to content

Commit 66fc3cb

Browse files
Merge pull request pandas-dev#10189 from mortada/doc_fixes
DOC/CLN: period_range kwarg descriptions missing and other minor doc …
2 parents 0aceb38 + 98a8390 commit 66fc3cb

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

pandas/core/groupby.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ class Grouper(object):
187187
188188
Examples
189189
--------
190-
>>> df.groupby(Grouper(key='A')) : syntatic sugar for df.groupby('A')
190+
>>> df.groupby(Grouper(key='A')) : syntactic sugar for df.groupby('A')
191191
>>> df.groupby(Grouper(key='date',freq='60s')) : specify a resample on the column 'date'
192192
>>> df.groupby(Grouper(level='date',freq='60s',axis=1)) :
193193
specify a resample on the level 'date' on the columns axis with a frequency of 60s

pandas/tseries/period.py

+6-7
Original file line numberDiff line numberDiff line change
@@ -110,20 +110,20 @@ class PeriodIndex(DatetimeIndexOpsMixin, Int64Index):
110110
111111
Parameters
112112
----------
113-
data : array-like (1-dimensional), optional
113+
data : array-like (1-dimensional), optional
114114
Optional period-like data to construct index with
115115
dtype : NumPy dtype (default: i8)
116-
copy : bool
116+
copy : bool
117117
Make a copy of input ndarray
118118
freq : string or period object, optional
119119
One of pandas period strings or corresponding objects
120120
start : starting value, period-like, optional
121121
If data is None, used as the start point in generating regular
122122
period data.
123-
periods : int, optional, > 0
123+
periods : int, optional, > 0
124124
Number of periods to generate, if generating index. Takes precedence
125125
over end argument
126-
end : end value, period-like, optional
126+
end : end value, period-like, optional
127127
If periods is none, generated index will extend to first conforming
128128
period on or just past end argument
129129
year : int, array, or Series, default None
@@ -501,7 +501,6 @@ def shift(self, n):
501501
----------
502502
n : int
503503
Periods to shift by
504-
freq : freq string
505504
506505
Returns
507506
-------
@@ -970,8 +969,8 @@ def period_range(start=None, end=None, periods=None, freq='D', name=None):
970969
971970
Parameters
972971
----------
973-
start :
974-
end :
972+
start : starting value, period-like, optional
973+
end : ending value, period-like, optional
975974
periods : int, default None
976975
Number of periods in the index
977976
freq : str/DateOffset, default 'D'

0 commit comments

Comments
 (0)