-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Add missing API item to reference docs #48455
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
ceee8ec
4e827af
79dc3cf
1a85db1
cbeb360
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,20 +19,21 @@ objects contained with a :class:`Index`, :class:`Series`, or | |
For some data types, pandas extends NumPy's type system. String aliases for these types | ||
can be found at :ref:`basics.dtypes`. | ||
|
||
=================== ========================= ============================= ============================= | ||
Kind of Data pandas Data Type Scalar Array | ||
=================== ========================= ============================= ============================= | ||
TZ-aware datetime :class:`DatetimeTZDtype` :class:`Timestamp` :ref:`api.arrays.datetime` | ||
Timedeltas (none) :class:`Timedelta` :ref:`api.arrays.timedelta` | ||
Period (time spans) :class:`PeriodDtype` :class:`Period` :ref:`api.arrays.period` | ||
Intervals :class:`IntervalDtype` :class:`Interval` :ref:`api.arrays.interval` | ||
Nullable Integer :class:`Int64Dtype`, ... (none) :ref:`api.arrays.integer_na` | ||
Categorical :class:`CategoricalDtype` (none) :ref:`api.arrays.categorical` | ||
Sparse :class:`SparseDtype` (none) :ref:`api.arrays.sparse` | ||
Strings :class:`StringDtype` :class:`str` :ref:`api.arrays.string` | ||
Boolean (with NA) :class:`BooleanDtype` :class:`bool` :ref:`api.arrays.bool` | ||
PyArrow :class:`ArrowDtype` Python Scalars or :class:`NA` :ref:`api.arrays.arrow` | ||
=================== ========================= ============================= ============================= | ||
=================== ========================== ============================= ============================= | ||
Kind of Data pandas Data Type Scalar Array | ||
=================== ========================== ============================= ============================= | ||
TZ-aware datetime :class:`DatetimeTZDtype` :class:`Timestamp` :ref:`api.arrays.datetime` | ||
Timedeltas (none) :class:`Timedelta` :ref:`api.arrays.timedelta` | ||
Period (time spans) :class:`PeriodDtype` :class:`Period` :ref:`api.arrays.period` | ||
Intervals :class:`IntervalDtype` :class:`Interval` :ref:`api.arrays.interval` | ||
Nullable Integer :class:`Int64Dtype`, ... (none) :ref:`api.arrays.integer_na` | ||
Nullable Float :class:`Float64Dtype`, ... (none) :ref:`api.arrays.float_na` | ||
Categorical :class:`CategoricalDtype` (none) :ref:`api.arrays.categorical` | ||
Sparse :class:`SparseDtype` (none) :ref:`api.arrays.sparse` | ||
Strings :class:`StringDtype` :class:`str` :ref:`api.arrays.string` | ||
Nullable Boolean :class:`BooleanDtype` :class:`bool` :ref:`api.arrays.bool` | ||
PyArrow :class:`ArrowDtype` Python Scalars or :class:`NA` :ref:`api.arrays.arrow` | ||
=================== ========================== ============================= ============================= | ||
|
||
pandas and third-party libraries can extend NumPy's type system (see :ref:`extending.extension-types`). | ||
The top-level :meth:`array` method can be used to create a new array, which may be | ||
|
@@ -91,13 +92,20 @@ with the :class:`arrays.DatetimeArray` extension array, which can hold timezone- | |
or timezone-aware values. | ||
|
||
:class:`Timestamp`, a subclass of :class:`datetime.datetime`, is pandas' | ||
scalar type for timezone-naive or timezone-aware datetime data. | ||
scalar type for timezone-naive or timezone-aware datetime data. :class:`NaT` | ||
is the missing value for datetime data. | ||
|
||
.. autosummary:: | ||
:toctree: api/ | ||
|
||
Timestamp | ||
|
||
.. autosummary:: | ||
:toctree: api/ | ||
:template: autosummary/class_without_autosummary.rst | ||
|
||
NaT | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you need a blank line between directive options and the values, I think this is why the CI is failing. |
||
|
||
Properties | ||
~~~~~~~~~~ | ||
.. autosummary:: | ||
|
@@ -208,13 +216,20 @@ Timedeltas | |
---------- | ||
|
||
NumPy can natively represent timedeltas. pandas provides :class:`Timedelta` | ||
for symmetry with :class:`Timestamp`. | ||
for symmetry with :class:`Timestamp`. :class:`NaT` | ||
is the missing value for timedelta data. | ||
|
||
.. autosummary:: | ||
:toctree: api/ | ||
|
||
Timedelta | ||
|
||
.. autosummary:: | ||
:toctree: api/ | ||
:template: autosummary/class_without_autosummary.rst | ||
|
||
NaT | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Blank line |
||
|
||
Properties | ||
~~~~~~~~~~ | ||
.. autosummary:: | ||
|
@@ -419,6 +434,26 @@ pandas provides this through :class:`arrays.IntegerArray`. | |
UInt16Dtype | ||
UInt32Dtype | ||
UInt64Dtype | ||
NA | ||
|
||
.. _api.arrays.float_na: | ||
|
||
Nullable float | ||
-------------- | ||
|
||
.. autosummary:: | ||
:toctree: api/ | ||
:template: autosummary/class_without_autosummary.rst | ||
|
||
arrays.FloatingArray | ||
|
||
.. autosummary:: | ||
:toctree: api/ | ||
:template: autosummary/class_without_autosummary.rst | ||
|
||
Float32Dtype | ||
Float64Dtype | ||
NA | ||
Comment on lines
+444
to
+456
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you know what's the advantage of having this in two separate autosummaries? I see you used the same format of the rest, and it's fine, but I wonder if this is just to allow different sizes of the columns of the two tables, or if there is anything else. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I am not immediately sure. I suppose different column sizes was the reason in the past but I was just using the same formatting as other sections |
||
|
||
.. _api.arrays.categorical: | ||
|
||
|
@@ -555,6 +590,7 @@ with a bool :class:`numpy.ndarray`. | |
:template: autosummary/class_without_autosummary.rst | ||
|
||
BooleanDtype | ||
NA | ||
|
||
|
||
.. Dtype attributes which are manually listed in their docstrings: including | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,6 +26,7 @@ Data manipulations | |
from_dummies | ||
factorize | ||
unique | ||
lreshape | ||
wide_to_long | ||
|
||
Top-level missing data | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the only line you added, right? With the wider column is not immediately clear in the diff.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct, since
:class:`Float64Dtype`, ...
was wider than the section boundaries (===...
) everything needed to shift.Also renamed
Boolean (with NA)
toNullable Boolean
to match the int and float titles.