Skip to content

Commit 5ea3f4a

Browse files
committed
Merge pull request #5207 from jorisvandenbossche/docs-note
DOC: Note -> Notes (numpydoc docstring section)
2 parents 8be33c5 + 02f040c commit 5ea3f4a

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

pandas/core/groupby.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2001,8 +2001,8 @@ def transform(self, func, *args, **kwargs):
20012001
f : function
20022002
Function to apply to each subframe
20032003
2004-
Note
2005-
----
2004+
Notes
2005+
-----
20062006
Each subframe is endowed the attribute 'name' in case you need to know
20072007
which group you are working on.
20082008
@@ -2113,8 +2113,8 @@ def filter(self, func, dropna=True, *args, **kwargs):
21132113
dropna : Drop groups that do not pass the filter. True by default;
21142114
if False, groups that evaluate False are filled with NaNs.
21152115
2116-
Note
2117-
----
2116+
Notes
2117+
-----
21182118
Each subframe is endowed the attribute 'name' in case you need to know
21192119
which group you are working on.
21202120

pandas/core/index.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ class Index(FrozenNDArray):
7171
name : object
7272
Name to be stored in the index
7373
74-
Note
75-
----
74+
Notes
75+
-----
7676
An Index instance can **only** contain hashable objects
7777
"""
7878
# To hand over control to subclasses
@@ -1634,8 +1634,8 @@ class Int64Index(Index):
16341634
name : object
16351635
Name to be stored in the index
16361636
1637-
Note
1638-
----
1637+
Notes
1638+
-----
16391639
An Index instance can **only** contain hashable objects
16401640
"""
16411641

@@ -1731,8 +1731,8 @@ class Float64Index(Index):
17311731
name : object
17321732
Name to be stored in the index
17331733
1734-
Note
1735-
----
1734+
Notes
1735+
-----
17361736
An Index instance can **only** contain hashable objects
17371737
"""
17381738

pandas/core/reshape.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,8 @@ def pivot_simple(index, columns, values):
357357
values : ndarray
358358
Values to use for populating new frame's values
359359
360-
Note
361-
----
360+
Notes
361+
-----
362362
Obviously, all 3 of the input arguments must have the same length
363363
364364
Returns

pandas/core/strings.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -345,8 +345,8 @@ def str_extract(arr, pat, flags=0):
345345
extracted groups : Series (one group) or DataFrame (multiple groups)
346346
347347
348-
Note
349-
----
348+
Notes
349+
-----
350350
Compare to the string method match, which returns re.match objects.
351351
"""
352352
regex = re.compile(pat, flags=flags)

pandas/tseries/offsets.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1354,8 +1354,8 @@ def generate_range(start=None, end=None, periods=None,
13541354
time_rule : (legacy) name of DateOffset object to be used, optional
13551355
Corresponds with names expected by tseries.frequencies.get_offset
13561356
1357-
Note
1358-
----
1357+
Notes
1358+
-----
13591359
* This method is faster for generating weekdays than dateutil.rrule
13601360
* At least two of (start, end, periods) must be specified.
13611361
* If both start and end are specified, the returned dates will

0 commit comments

Comments
 (0)