update

pandas-dev · jreback · Jan 3, 2020 · Dec 16, 2019 · Dec 18, 2019 · Dec 18, 2019
commit 3bbf868eb1033b9aace90921cef4d8a460ecfa85
diff --git a/doc/source/reference/extensions.rst b/doc/source/reference/extensions.rst
@@ -18,6 +18,8 @@ objects.
    api.extensions.register_series_accessor
    api.extensions.register_index_accessor
    api.extensions.ExtensionDtype
+   api.extensions.is_bool_indexer
+   api.extensions.check_bool_array_indexer
 
 .. autosummary::
    :toctree: api/
@@ -26,6 +28,7 @@ objects.
    api.extensions.ExtensionArray
    arrays.PandasArray
 
+
 .. We need this autosummary so that methods and attributes are generated.
 .. Separate block, since they aren't classes.
 

diff --git a/pandas/core/common.py b/pandas/core/common.py
@@ -110,12 +110,18 @@ def is_bool_indexer(key: Any) -> bool:
     Returns
     -------
     bool
+        Whether `key` is a valid boolean indexer.
 
     Raises
     ------
     ValueError
         When the array is an object-dtype ndarray or ExtensionArray
         and contains missing values.
+
+    See Also
+    --------
+    api.extensions.check_bool_array_indexer : Check that `key`
+        is a valid mask for an array, and convert to an ndarary.
     """
     na_msg = "cannot index with vector containing NA / NaN values"
     if isinstance(key, (ABCSeries, np.ndarray, ABCIndex)) or (

diff --git a/pandas/core/indexing.py b/pandas/core/indexing.py
@@ -2301,6 +2301,9 @@ def check_bool_array_indexer(array: AnyArrayLike, mask: AnyArrayLike) -> np.ndar
     numpy.ndarray
         The validated boolean mask.
 
+    See Also
+    --------
+    api.extensions.is_bool_indexer : Check if `key` is a boolean indexer.
     """
     result = np.asarray(mask, dtype=bool)
     # GH26658