Skip to content

Commit e325320

Browse files
authored
DOC: SS03 numpydoc validation (#44536)
1 parent a66a093 commit e325320

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed

ci/code_checks.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ fi
9393
### DOCSTRINGS ###
9494
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9595

96-
MSG='Validate docstrings (GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG
97-
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS02,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA02,SA03
96+
MSG='Validate docstrings (GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS01, SS02, SS03, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA02, SA03)' ; echo $MSG
97+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS02,SS03,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA02,SA03
9898
RET=$(($RET + $?)) ; echo $MSG "DONE"
9999

100100
fi

pandas/_config/config.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ class RegisteredOption(NamedTuple):
9898
class OptionError(AttributeError, KeyError):
9999
"""
100100
Exception for pandas.options, backwards compatible with KeyError
101-
checks
101+
checks.
102102
"""
103103

104104

pandas/_libs/tslibs/offsets.pyx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2247,7 +2247,7 @@ cdef class MonthBegin(MonthOffset):
22472247

22482248
cdef class BusinessMonthEnd(MonthOffset):
22492249
"""
2250-
DateOffset increments between the last business day of the month
2250+
DateOffset increments between the last business day of the month.
22512251
22522252
Examples
22532253
--------

pandas/core/groupby/groupby.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ class providing the base-class of operations.
325325
_transform_template = """
326326
Call function producing a like-indexed %(klass)s on each group and
327327
return a %(klass)s having the same indexes as the original object
328-
filled with the transformed values
328+
filled with the transformed values.
329329
330330
Parameters
331331
----------

pandas/core/indexers/objects.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ def get_window_bounds(
124124

125125

126126
class VariableOffsetWindowIndexer(BaseIndexer):
127-
"""Calculate window boundaries based on a non-fixed offset such as a BusinessDay"""
127+
"""Calculate window boundaries based on a non-fixed offset such as a BusinessDay."""
128128

129129
def __init__(
130130
self,

pandas/core/indexes/multi.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -732,7 +732,7 @@ def array(self):
732732
@cache_readonly
733733
def dtypes(self) -> Series:
734734
"""
735-
Return the dtypes as a Series for the underlying MultiIndex
735+
Return the dtypes as a Series for the underlying MultiIndex.
736736
"""
737737
from pandas import Series
738738

0 commit comments

Comments
 (0)