Skip to content

Commit c90294d

Browse files
dataxerikDerek Sharp
and
Derek Sharp
authored
DOC: fix SA04 errors flagged by validate_docstrings.py and add SA04 t… (#46652)
* DOC: fix SA04 errors flagged by validate_docstrings.py and add SA04 to code_checks.sh * DOC: apply feedback * DOC: change Series/Dataframe to just Dataframe * DOC: move to one line Co-authored-by: Derek Sharp <[email protected]>
1 parent 32999a1 commit c90294d

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

ci/code_checks.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ fi
7878
### DOCSTRINGS ###
7979
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8080

81-
MSG='Validate docstrings (EX04, GL01, GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT04, RT05, SA02, SA03, SS01, SS02, SS03, SS04, SS05)' ; echo $MSG
82-
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT04,RT05,SA02,SA03,SS01,SS02,SS03,SS04,SS05
81+
MSG='Validate docstrings (EX04, GL01, GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT04, RT05, SA02, SA03, SA04, SS01, SS02, SS03, SS04, SS05)' ; echo $MSG
82+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05
8383
RET=$(($RET + $?)) ; echo $MSG "DONE"
8484

8585
fi

pandas/core/indexes/base.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -4371,8 +4371,8 @@ def reindex(
43714371
43724372
See Also
43734373
--------
4374-
Series.reindex
4375-
DataFrame.reindex
4374+
Series.reindex : Conform Series to new index with optional filling logic.
4375+
DataFrame.reindex : Conform DataFrame to new index with optional filling logic.
43764376
43774377
Examples
43784378
--------

0 commit comments

Comments
 (0)