Skip to content

Commit e8c5df7

Browse files
committed
Adding explicit list of ExtensionArray methods and attributes to extensions.rst.
1 parent 4db99f1 commit e8c5df7

File tree

2 files changed

+36
-7
lines changed

2 files changed

+36
-7
lines changed

doc/source/reference/extensions.rst

+26-1
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,35 @@ objects.
1818
api.extensions.register_series_accessor
1919
api.extensions.register_index_accessor
2020
api.extensions.ExtensionDtype
21-
api.extensions.ExtensionArray
2221

2322
.. autosummary::
2423
:toctree: api/
2524
:template: autosummary/class_without_autosummary.rst
2625

26+
api.extensions.ExtensionArray
2727
arrays.PandasArray
28+
29+
.. We need this autosummary so that methods and attributes are generated.
30+
.. Separate block, since they aren't classes.
31+
32+
.. autosummary::
33+
:toctree: api/
34+
35+
api.extensions.ExtensionArray._values_for_factorize
36+
api.extensions.ExtensionArray.argsort
37+
api.extensions.ExtensionArray.astype
38+
api.extensions.ExtensionArray.copy
39+
api.extensions.ExtensionArray.dropna
40+
api.extensions.ExtensionArray.factorize
41+
api.extensions.ExtensionArray.fillna
42+
api.extensions.ExtensionArray.isna
43+
api.extensions.ExtensionArray.ravel
44+
api.extensions.ExtensionArray.repeat
45+
api.extensions.ExtensionArray.searchsorted
46+
api.extensions.ExtensionArray.shift
47+
api.extensions.ExtensionArray.take
48+
api.extensions.ExtensionArray.unique
49+
api.extensions.ExtensionArray.dtype
50+
api.extensions.ExtensionArray.nbytes
51+
api.extensions.ExtensionArray.ndim
52+
api.extensions.ExtensionArray.shape

pandas/core/arrays/base.py

+10-6
Original file line numberDiff line numberDiff line change
@@ -678,7 +678,7 @@ def factorize(self, na_sentinel: int = -1) -> Tuple[np.ndarray, ABCExtensionArra
678678
679679
See Also
680680
--------
681-
pandas.factorize : Top-level factorize method that dispatches here.
681+
factorize : Top-level factorize method that dispatches here.
682682
683683
Notes
684684
-----
@@ -802,18 +802,18 @@ def take(
802802
When `indices` contains negative values other than ``-1``
803803
and `allow_fill` is True.
804804
805+
See Also
806+
--------
807+
numpy.take
808+
api.extensions.take
809+
805810
Notes
806811
-----
807812
ExtensionArray.take is called by ``Series.__getitem__``, ``.loc``,
808813
``iloc``, when `indices` is a sequence of values. Additionally,
809814
it's called by :meth:`Series.reindex`, or any other method
810815
that causes realignment, with a `fill_value`.
811816
812-
See Also
813-
--------
814-
numpy.take
815-
pandas.api.extensions.take
816-
817817
Examples
818818
--------
819819
Here's an example implementation, which relies on casting the
@@ -928,6 +928,10 @@ def ravel(self, order="C") -> ABCExtensionArray:
928928
----------
929929
order : {None, 'C', 'F', 'A', 'K'}, default 'C'
930930
931+
Returns
932+
-------
933+
ExtensionArray
934+
931935
Notes
932936
-----
933937
- Because ExtensionArrays are 1D-only, this is a no-op.

0 commit comments

Comments
 (0)