Skip to content

Commit 4972fd3

Browse files
refactorielproost
authored andcommitted
DOC: Fix missing periods and non capitalized summary beginnings (pandas-dev#28858)
1 parent 7a15be8 commit 4972fd3

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

pandas/_libs/tslibs/period.pyx

+3-3
Original file line numberDiff line numberDiff line change
@@ -1710,7 +1710,7 @@ cdef class _Period:
17101710
def asfreq(self, freq, how='E'):
17111711
"""
17121712
Convert Period to desired frequency, either at the start or end of the
1713-
interval
1713+
interval.
17141714
17151715
Parameters
17161716
----------
@@ -1777,7 +1777,7 @@ cdef class _Period:
17771777
def to_timestamp(self, freq=None, how='start', tz=None):
17781778
"""
17791779
Return the Timestamp representation of the Period at the target
1780-
frequency at the specified end (how) of the Period
1780+
frequency at the specified end (how) of the Period.
17811781
17821782
Parameters
17831783
----------
@@ -2380,7 +2380,7 @@ cdef class _Period:
23802380

23812381
class Period(_Period):
23822382
"""
2383-
Represents a period of time
2383+
Represents a period of time.
23842384
23852385
Parameters
23862386
----------

pandas/_libs/tslibs/timedeltas.pyx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1344,7 +1344,7 @@ class Timedelta(_Timedelta):
13441344

13451345
def floor(self, freq):
13461346
"""
1347-
return a new Timedelta floored to this resolution.
1347+
Return a new Timedelta floored to this resolution.
13481348
13491349
Parameters
13501350
----------
@@ -1355,7 +1355,7 @@ class Timedelta(_Timedelta):
13551355

13561356
def ceil(self, freq):
13571357
"""
1358-
return a new Timedelta ceiled to this resolution.
1358+
Return a new Timedelta ceiled to this resolution.
13591359
13601360
Parameters
13611361
----------

pandas/core/arrays/interval.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -975,7 +975,7 @@ def length(self):
975975
@property
976976
def mid(self):
977977
"""
978-
Return the midpoint of each Interval in the IntervalArray as an Index
978+
Return the midpoint of each Interval in the IntervalArray as an Index.
979979
"""
980980
try:
981981
return 0.5 * (self.left + self.right)

pandas/io/formats/style.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -849,7 +849,7 @@ def set_uuid(self, uuid):
849849

850850
def set_caption(self, caption):
851851
"""
852-
Set the caption on a Styler
852+
Set the caption on a Styler.
853853
854854
Parameters
855855
----------

pandas/plotting/_misc.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
def table(ax, data, rowLabels=None, colLabels=None, **kwargs):
1010
"""
11-
Helper function to convert DataFrame and Series to matplotlib.table
11+
Helper function to convert DataFrame and Series to matplotlib.table.
1212
1313
Parameters
1414
----------
@@ -32,7 +32,7 @@ def table(ax, data, rowLabels=None, colLabels=None, **kwargs):
3232

3333
def register(explicit=True):
3434
"""
35-
Register Pandas Formatters and Converters with matplotlib
35+
Register Pandas Formatters and Converters with matplotlib.
3636
3737
This function modifies the global ``matplotlib.units.registry``
3838
dictionary. Pandas adds custom converters for
@@ -54,7 +54,7 @@ def register(explicit=True):
5454

5555
def deregister():
5656
"""
57-
Remove pandas' formatters and converters
57+
Remove pandas' formatters and converters.
5858
5959
Removes the custom converters added by :func:`register`. This
6060
attempts to set the state of the registry back to the state before

0 commit comments

Comments
 (0)