Skip to content

Commit d208d64

Browse files
authored
DOC: Fixing EX01 - Added example (#54384)
Example for ExtensionArray
1 parent 3fe6149 commit d208d64

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

ci/code_checks.sh

+2-7
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,8 @@ fi
5757
### DOCSTRINGS ###
5858
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
5959

60-
MSG='Validate docstrings (EX02, EX04, GL01, GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT02, RT04, RT05, SA02, SA03, SA04, SS01, SS02, SS03, SS04, SS05, SS06)' ; echo $MSG
61-
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX02,EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT02,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05,SS06
62-
RET=$(($RET + $?)) ; echo $MSG "DONE"
63-
64-
MSG='Partially validate docstrings (EX01)' ; echo $MSG
65-
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \
66-
pandas.api.extensions.ExtensionArray \
60+
MSG='Validate docstrings (EX01, EX02, EX04, GL01, GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT02, RT04, RT05, SA02, SA03, SA04, SS01, SS02, SS03, SS04, SS05, SS06)' ; echo $MSG
61+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01,EX02,EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT02,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05,SS06
6762
RET=$(($RET + $?)) ; echo $MSG "DONE"
6863

6964
fi

pandas/core/arrays/base.py

+6
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,12 @@ class ExtensionArray:
239239
240240
By default, ExtensionArrays are not hashable. Immutable subclasses may
241241
override this behavior.
242+
243+
Examples
244+
--------
245+
Please see the following:
246+
247+
https://github.com/pandas-dev/pandas/blob/main/pandas/tests/extension/list/array.py
242248
"""
243249

244250
# '_typ' is for pandas.core.dtypes.generic.ABCExtensionArray.

0 commit comments

Comments
 (0)