Skip to content

Commit a7ca350

Browse files
committed
DOC: Add guide links to relevant API docs
- Add links from API reference pages back to user guides - Links Series, DataFrame, Index, GroupBy, IO, Window, Plotting, Style, General Functions, Missing Values, and Resampling APIs to their corresponding user guide sections - Addresses issue #62357: Ensure guides are linked from relevant API docs Files modified: - doc/source/reference/series.rst → Essential basic functionality - doc/source/reference/frame.rst → Essential basic functionality - doc/source/reference/indexing.rst → Essential basic functionality - doc/source/reference/groupby.rst → Group by: split-apply-combine - doc/source/reference/io.rst → IO Tools - doc/source/reference/window.rst → Windowing operations - doc/source/reference/plotting.rst → Visualization - doc/source/reference/general_functions.rst → Reshaping and pivot tables - doc/source/reference/missing_value.rst → Working with missing data - doc/source/reference/resampling.rst → Time series / date functionality - doc/source/reference/style.rst → Table Visualization
1 parent 1863adb commit a7ca350

File tree

11 files changed

+33
-0
lines changed

11 files changed

+33
-0
lines changed

doc/source/reference/frame.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ DataFrame
77
=========
88
.. currentmodule:: pandas
99

10+
.. note::
11+
For more information on using DataFrame, see the :ref:`Essential basic functionality <basics>` section of the User Guide.
12+
1013
Constructor
1114
~~~~~~~~~~~
1215
.. autosummary::

doc/source/reference/general_functions.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ General functions
77
=================
88
.. currentmodule:: pandas
99

10+
.. note::
11+
For more information on general data manipulation functions, see the :ref:`Reshaping and pivot tables <reshaping>` section of the User Guide.
12+
1013
Data manipulations
1114
~~~~~~~~~~~~~~~~~~
1215
.. autosummary::

doc/source/reference/groupby.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ GroupBy
77
=======
88
.. currentmodule:: pandas.core.groupby
99

10+
.. note::
11+
For more information on using GroupBy, see the :ref:`Group by: split-apply-combine <groupby>` section of the User Guide.
12+
1013
:class:`pandas.api.typing.DataFrameGroupBy` and :class:`pandas.api.typing.SeriesGroupBy`
1114
instances are returned by groupby calls :func:`pandas.DataFrame.groupby` and
1215
:func:`pandas.Series.groupby` respectively.

doc/source/reference/indexing.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Index
1010
-----
1111
.. currentmodule:: pandas
1212

13+
.. note::
14+
For more information on using Index, see the :ref:`Essential basic functionality <basics>` section of the User Guide.
15+
1316
**Many of these methods or variants thereof are available on the objects
1417
that contain an index (Series/DataFrame) and those should most likely be
1518
used before calling these methods directly.**

doc/source/reference/io.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Input/output
77
============
88
.. currentmodule:: pandas
99

10+
.. note::
11+
For more information on input/output operations, see the :ref:`IO Tools <io>` section of the User Guide.
12+
1013
Pickling
1114
~~~~~~~~
1215
.. autosummary::

doc/source/reference/missing_value.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Missing values
77
==============
88
.. currentmodule:: pandas
99

10+
.. note::
11+
For more information on working with missing values, see the :ref:`Working with missing data <missing_data>` section of the User Guide.
12+
1013
NA is the way to represent missing values for nullable dtypes (see below):
1114

1215
.. autosummary::

doc/source/reference/plotting.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Plotting
77
========
88
.. currentmodule:: pandas.plotting
99

10+
.. note::
11+
For more information on plotting, see the :ref:`Visualization <visualization>` section of the User Guide.
12+
1013
The following functions are contained in the ``pandas.plotting`` module.
1114

1215
.. autosummary::

doc/source/reference/resampling.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Resampling
77
==========
88
.. currentmodule:: pandas.core.resample
99

10+
.. note::
11+
For more information on resampling, see the :ref:`Time series / date functionality <timeseries>` section of the User Guide.
12+
1013
:class:`pandas.api.typing.Resampler` instances are returned by
1114
resample calls: :func:`pandas.DataFrame.resample`, :func:`pandas.Series.resample`.
1215

doc/source/reference/series.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Series
77
======
88
.. currentmodule:: pandas
99

10+
.. note::
11+
For more information on using Series, see the :ref:`Essential basic functionality <basics>` section of the User Guide.
12+
1013
Constructor
1114
-----------
1215
.. autosummary::

doc/source/reference/style.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Style
77
=====
88
.. currentmodule:: pandas.io.formats.style
99

10+
.. note::
11+
For more information on styling, see the `Table Visualization <../user_guide/style.ipynb>`_ section of the User Guide.
12+
1013
``Styler`` objects are returned by :attr:`pandas.DataFrame.style`.
1114

1215
Styler constructor

0 commit comments

Comments
 (0)