DOC: Add missing API item to reference docs #48455
Conversation
| 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` |
There was a problem hiding this comment.
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.
Correct, since :class:`Float64Dtype`, ... was wider than the section boundaries (===...) everything needed to shift.
Also renamed Boolean (with NA) to Nullable Boolean to match the int and float titles.
| .. autosummary:: | ||
| :toctree: api/ | ||
| :template: autosummary/class_without_autosummary.rst | ||
|
|
||
| arrays.FloatingArray | ||
|
|
||
| .. autosummary:: | ||
| :toctree: api/ | ||
| :template: autosummary/class_without_autosummary.rst | ||
|
|
||
| Float32Dtype | ||
| Float64Dtype | ||
| NA |
There was a problem hiding this comment.
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.
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
pandas/core/groupby/generic.py
Outdated
| Returns | ||
| ------- | ||
| NamedTuple | ||
|
|
There was a problem hiding this comment.
If I'm not missing anything, I don't think we should have a Returns section in the docstring of a class (only for functions). Is numpydoc complaining if this is missing?
There was a problem hiding this comment.
Ah thanks good call. Yeah I think I don't need to add this. Will remove.
pandas/core/groupby/generic.py
Outdated
| Parameters | ||
| ---------- | ||
| column : Hashable | ||
| Column label in the DataFrame to apply aggfunc |
There was a problem hiding this comment.
| Column label in the DataFrame to apply aggfunc | |
| Column label in the DataFrame to apply aggfunc. |
| .. autosummary:: | ||
| :toctree: api/ | ||
| :template: autosummary/class_without_autosummary.rst | ||
| NaT |
There was a problem hiding this comment.
I think you need a blank line between directive options and the values, I think this is why the CI is failing.
| .. autosummary:: | ||
| :toctree: api/ | ||
| :template: autosummary/class_without_autosummary.rst | ||
| NaT |
|
Will merge in a few days if no further comments. |
* DOC: Add missing API item to reference docs * Address review * Fix formatting
Float32/64Dtype&arrays.FloatingArrayNaT&NAlreshapeset_eng_float_formatNamedAgg