Skip to content

Commit cb33796

Browse files
authored
DOC: add series.info to api reference (#60926)
* docs: add series.info to api reference * fixup
1 parent 0305656 commit cb33796

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

doc/source/reference/series.rst

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Attributes
2525
Series.array
2626
Series.values
2727
Series.dtype
28+
Series.info
2829
Series.shape
2930
Series.nbytes
3031
Series.ndim

doc/source/whatsnew/v3.0.0.rst

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Other enhancements
3232
- :class:`pandas.api.typing.SASReader` is available for typing the output of :func:`read_sas` (:issue:`55689`)
3333
- :meth:`pandas.api.interchange.from_dataframe` now uses the `PyCapsule Interface <https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html>`_ if available, only falling back to the Dataframe Interchange Protocol if that fails (:issue:`60739`)
3434
- Added :meth:`.Styler.to_typst` to write Styler objects to file, buffer or string in Typst format (:issue:`57617`)
35+
- Added missing :meth:`pandas.Series.info` to API reference (:issue:`60926`)
3536
- :class:`pandas.api.typing.NoDefault` is available for typing ``no_default``
3637
- :func:`DataFrame.to_excel` now raises an ``UserWarning`` when the character count in a cell exceeds Excel's limitation of 32767 characters (:issue:`56954`)
3738
- :func:`pandas.merge` now validates the ``how`` parameter input (merge type) (:issue:`59435`)

pandas/io/formats/info.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -226,12 +226,17 @@
226226
Series.describe: Generate descriptive statistics of Series.
227227
Series.memory_usage: Memory usage of Series."""
228228
)
229+
series_max_cols_sub = dedent(
230+
"""\
231+
max_cols : int, optional
232+
Unused, exists only for compatibility with DataFrame.info."""
233+
)
229234

230235

231236
series_sub_kwargs = {
232237
"klass": "Series",
233238
"type_sub": "",
234-
"max_cols_sub": "",
239+
"max_cols_sub": series_max_cols_sub,
235240
"show_counts_sub": show_counts_sub,
236241
"examples_sub": series_examples_sub,
237242
"see_also_sub": series_see_also_sub,

0 commit comments

Comments
 (0)