DOC: Various EA docs #20707
DOC: Various EA docs #20707
Conversation
TomAugspurger
added
the
ExtensionArray
doc/source/extending.rst
Outdated
| @@ -106,6 +113,24 @@ by some other storage type, like Python lists. | |||
| See the `extension array source`_ for the interface definition. The docstrings | |||
| and comments contain guidance for properly implementing the interface. | |||
|
|
|||
| We provide a test suite for ensuring that your extension arrays satisfy the expected | |||
| behavior. To use the test-suite, you must provide several pytest fixtures and inherit | |||
There was a problem hiding this comment.
"test-suite" or "test suite" (without the dash)? You use both.
doc/source/extending.rst
Outdated
| from the base test class. The required fixtures are found in | ||
| https://github.com/pandas-dev/pandas/blob/master/pandas/tests/extension/conftest.py. | ||
|
|
||
| To use a test, subclass it |
There was a problem hiding this comment.
Nit: do we want a colon at the end of this sentence?
|
BTW, I see some other docs changes (re: Python 2.7 support) that aren't quite pertinent to |
Codecov Report
@@ Coverage Diff @@
## master #20707 +/- ##
==========================================
+ Coverage 91.81% 91.82% +0.01%
==========================================
Files 153 153
Lines 49279 49307 +28
==========================================
+ Hits 45245 45276 +31
+ Misses 4034 4031 -3
Continue to review full report at Codecov.
|
| @@ -14,12 +14,15 @@ class ExtensionArray(object): | |||
| with a custom type and will not attempt to coerce them to objects. They | |||
| may be stored directly inside a :class:`DataFrame` or :class:`Series`. | |||
|
|
|||
| .. versionadded:: 0.23.0 | |||
There was a problem hiding this comment.
Can you add a note about the experimental status in this file as well (eg in module docstring at line 1).
pandas/core/arrays/base.py
Outdated
| @@ -35,6 +38,15 @@ class ExtensionArray(object): | |||
| * _can_hold_na | |||
| * _formatting_values | |||
|
|
|||
| Some methods require casting the ExtensionArray to an ndarray of Python | |||
| objects, which may be expensive. When performance is a concern, we highly | |||
| recommend overriding the following methods. | |||
There was a problem hiding this comment.
Maybe clarify that those have a default working implementation, but do a self.astype(object) ?
|
thanks @TomAugspurger |
Closes #20668