Skip to content

Commit 34ef60b

Browse files
committed
Rename error code
1 parent 24d3592 commit 34ef60b

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

ci/code_checks.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ fi
6565
### DOCSTRINGS ###
6666
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
6767

68-
MSG='Validate docstrings (EX01, EX03, EX04, GL01, GL02, GL03, GL04, GL11, GL06, GL07, GL09, GL10, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT02, RT04, RT05, SA02, SA03, SA04, SA05, SS01, SS02, SS03, SS04, SS05, SS06)' ; echo $MSG
69-
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01,EX03,EX04,GL01,GL02,GL03,GL04,GL11,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT02,RT04,RT05,SA02,SA03,SA04,SA05,SS01,SS02,SS03,SS04,SS05,SS06
68+
MSG='Validate docstrings (EX01, EX03, EX04, GL01, GL02, GL03, GL04, GL06, GL07, GL09, GL10, PD01, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT02, RT04, RT05, SA02, SA03, SA04, SA05, SS01, SS02, SS03, SS04, SS05, SS06)' ; echo $MSG
69+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01,EX03,EX04,GL01,GL02,GL03,GL04,GL06,GL07,GL09,GL10,PD01,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT02,RT04,RT05,SA02,SA03,SA04,SA05,SS01,SS02,SS03,SS04,SS05,SS06
7070
RET=$(($RET + $?)) ; echo $MSG "DONE"
7171

7272
MSG='Partially validate docstrings (PR02)' ; echo $MSG

scripts/validate_docstrings.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
ERROR_MSGS = {
5858
"GL04": "Private classes ({mentioned_private_classes}) should not be "
5959
"mentioned in public docstrings",
60-
"GL11": "Use 'array-like' rather than 'array_like' in docstrings.",
60+
"PD01": "Use 'array-like' rather than 'array_like' in docstrings.",
6161
"SA05": "{reference_name} in `See Also` section does not need `pandas` "
6262
"prefix, use {right_reference} instead.",
6363
"EX03": "flake8 error: line {line_number}, col {col_number}: {error_code} "
@@ -277,7 +277,7 @@ def pandas_validate(func_name: str):
277277
)
278278

279279
if doc.non_hyphenated_array_like():
280-
result["errors"].append(pandas_error("GL11"))
280+
result["errors"].append(pandas_error("PD01"))
281281

282282
plt.close("all")
283283
return result

0 commit comments

Comments
 (0)