DOC: Fixing EX01 - Added examples (#54277)

Examples ExtensionArray._from_factorized, _from_sequence ...
pandas-dev · Jul 27, 2023 · 498c438 · 498c438
1 parent 577bb72
commit 498c438
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 9 deletions.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -63,8 +63,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
 
     MSG='Partially validate docstrings (EX01)' ;  echo $MSG
     $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \
-        pandas.errors.IncompatibilityWarning \
-        pandas.errors.OptionError \
         pandas.errors.PerformanceWarning \
         pandas.errors.PyperclipException \
         pandas.errors.PyperclipWindowsException \
@@ -77,16 +75,9 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         pandas.io.stata.StataWriter.write_file \
         pandas.plotting.deregister_matplotlib_converters \
         pandas.plotting.register_matplotlib_converters \
-        pandas.api.indexers.BaseIndexer \
-        pandas.api.indexers.VariableOffsetWindowIndexer \
-        pandas.util.hash_array \
-        pandas.util.hash_pandas_object \
-        pandas_object \
         pandas.api.extensions.ExtensionDtype \
         pandas.api.extensions.ExtensionArray \
         pandas.arrays.NumpyExtensionArray \
-        pandas.api.extensions.ExtensionArray._from_factorized \
-        pandas.api.extensions.ExtensionArray._from_sequence \
         pandas.api.extensions.ExtensionArray._from_sequence_of_strings \
         pandas.api.extensions.ExtensionArray._hash_pandas_object \
         pandas.api.extensions.ExtensionArray._reduce \

diff --git a/pandas/_config/config.py b/pandas/_config/config.py
@@ -111,6 +111,12 @@ class OptionError(AttributeError, KeyError):
     Exception raised for pandas.options.
 
     Backwards compatible with KeyError checks.
+
+    Examples
+    --------
+    >>> pd.options.context
+    Traceback (most recent call last):
+    OptionError: No such option
     """
 
 

diff --git a/pandas/core/arrays/base.py b/pandas/core/arrays/base.py
@@ -270,6 +270,13 @@ def _from_sequence(cls, scalars, *, dtype: Dtype | None = None, copy: bool = Fal
         Returns
         -------
         ExtensionArray
+
+        Examples
+        --------
+        >>> pd.arrays.IntegerArray._from_sequence([4, 5])
+        <IntegerArray>
+        [4, 5]
+        Length: 2, dtype: Int64
         """
         raise AbstractMethodError(cls)
 
@@ -313,6 +320,16 @@ def _from_factorized(cls, values, original):
         --------
         factorize : Top-level factorize method that dispatches here.
         ExtensionArray.factorize : Encode the extension array as an enumerated type.
+
+        Examples
+        --------
+        >>> interv_arr = pd.arrays.IntervalArray([pd.Interval(0, 1),
+        ...                                      pd.Interval(1, 5), pd.Interval(1, 5)])
+        >>> codes, uniques = pd.factorize(interv_arr)
+        >>> pd.arrays.IntervalArray._from_factorized(uniques, interv_arr)
+        <IntervalArray>
+        [(0, 1], (1, 5]]
+        Length: 2, dtype: interval[int64, right]
         """
         raise AbstractMethodError(cls)
 

diff --git a/scripts/validate_docstrings.py b/scripts/validate_docstrings.py
@@ -52,6 +52,7 @@
     "errors.InvalidComparison",
     "errors.LossySetitemError",
     "errors.NoBufferPresent",
+    "errors.IncompatibilityWarning",
 }
 PRIVATE_CLASSES = ["NDFrame", "IndexOpsMixin"]
 ERROR_MSGS = {