From 6b15b9bc534fd72ba39a4ab9337317e3fb1a82f7 Mon Sep 17 00:00:00 2001 From: Thomas Vranken Date: Sat, 15 Jul 2023 17:17:57 +0000 Subject: [PATCH 1/4] Removed indentation in documentation --- doc/source/reference/index.rst | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index bc1202b3d5554..32a585df07c6c 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -10,19 +10,18 @@ This page gives an overview of all public pandas objects, functions and methods. All classes and functions exposed in ``pandas.*`` namespace are public. The following subpackages are public. - - - ``pandas.errors``: Custom exception and warnings classes that are raised by pandas. - - ``pandas.plotting``: Plotting public API. - - ``pandas.testing``: Functions that are useful for writing tests involving pandas objects. - - ``pandas.api.extensions``: Functions and classes for extending pandas objects. - - ``pandas.api.indexers``: Functions and classes for rolling window indexers. - - ``pandas.api.interchange``: DataFrame interchange protocol. - - ``pandas.api.types``: Datatype classes and functions. - - ``pandas.api.typing``: Classes that may be necessary for type-hinting. These are - classes that are encountered as intermediate results but should not be - instantiated directly by users. These classes are not to be confused with - classes from the `pandas-stubs `_ - package which has classes in addition to those that occur in pandas for type-hinting. +- ``pandas.errors``: Custom exception and warnings classes that are raised by pandas. +- ``pandas.plotting``: Plotting public API. +- ``pandas.testing``: Functions that are useful for writing tests involving pandas objects. +- ``pandas.api.extensions``: Functions and classes for extending pandas objects. +- ``pandas.api.indexers``: Functions and classes for rolling window indexers. +- ``pandas.api.interchange``: DataFrame interchange protocol. +- ``pandas.api.types``: Datatype classes and functions. +- ``pandas.api.typing``: Classes that may be necessary for type-hinting. These are + classes that are encountered as intermediate results but should not be + instantiated directly by users. These classes are not to be confused with + classes from the `pandas-stubs `_ + package which has classes in addition to those that occur in pandas for type-hinting. In addition, public functions in ``pandas.io`` and ``pandas.tseries`` submodules are mentioned in the documentation. From 46fd195dd684d716adc9deb721fb8686d929ebf7 Mon Sep 17 00:00:00 2001 From: Thomas Vranken Date: Sun, 16 Jul 2023 14:52:33 +0000 Subject: [PATCH 2/4] Fixed indentation --- doc/source/reference/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 32a585df07c6c..72cb7e1e9b72f 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -31,8 +31,7 @@ are mentioned in the documentation. The ``pandas.core``, ``pandas.compat``, and ``pandas.util`` top-level modules are PRIVATE. Stable functionality in such modules is not guaranteed. -.. If you update this toctree, also update the manual toctree in the - main index.rst.template +.. If you update this toctree, also update the manual toctree in the main index.rst.template .. toctree:: :maxdepth: 2 From 0329b09d5e8aaa70de9ae1ac2be010a997e2ca26 Mon Sep 17 00:00:00 2001 From: Thomas Vranken Date: Sun, 16 Jul 2023 17:13:26 +0000 Subject: [PATCH 3/4] Fixed identation --- doc/source/reference/index.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 72cb7e1e9b72f..fd5eca405e3d8 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -10,6 +10,7 @@ This page gives an overview of all public pandas objects, functions and methods. All classes and functions exposed in ``pandas.*`` namespace are public. The following subpackages are public. + - ``pandas.errors``: Custom exception and warnings classes that are raised by pandas. - ``pandas.plotting``: Plotting public API. - ``pandas.testing``: Functions that are useful for writing tests involving pandas objects. @@ -17,11 +18,11 @@ The following subpackages are public. - ``pandas.api.indexers``: Functions and classes for rolling window indexers. - ``pandas.api.interchange``: DataFrame interchange protocol. - ``pandas.api.types``: Datatype classes and functions. -- ``pandas.api.typing``: Classes that may be necessary for type-hinting. These are - classes that are encountered as intermediate results but should not be - instantiated directly by users. These classes are not to be confused with - classes from the `pandas-stubs `_ - package which has classes in addition to those that occur in pandas for type-hinting. +- ``pandas.api.typing``: Classes that may be necessary for type-hinting. + These are classes that are encountered as intermediate results but should not be instantiated + directly by users. These classes are not to be confused with classes from the + `pandas-stubs `_ package + which has classes in addition to those that occur in pandas for type-hinting. In addition, public functions in ``pandas.io`` and ``pandas.tseries`` submodules are mentioned in the documentation. @@ -31,7 +32,8 @@ are mentioned in the documentation. The ``pandas.core``, ``pandas.compat``, and ``pandas.util`` top-level modules are PRIVATE. Stable functionality in such modules is not guaranteed. -.. If you update this toctree, also update the manual toctree in the main index.rst.template +.. If you update this toctree, also update the manual toctree in the +.. main index.rst.template .. toctree:: :maxdepth: 2 From 91f1179858aa5ba64678f0259bf6fdfa1cc4bf97 Mon Sep 17 00:00:00 2001 From: Thomas Vranken Date: Sun, 16 Jul 2023 21:26:21 +0000 Subject: [PATCH 4/4] Fixed indentation --- doc/source/reference/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index fd5eca405e3d8..6d3ce3d31f005 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -19,10 +19,10 @@ The following subpackages are public. - ``pandas.api.interchange``: DataFrame interchange protocol. - ``pandas.api.types``: Datatype classes and functions. - ``pandas.api.typing``: Classes that may be necessary for type-hinting. - These are classes that are encountered as intermediate results but should not be instantiated - directly by users. These classes are not to be confused with classes from the - `pandas-stubs `_ package - which has classes in addition to those that occur in pandas for type-hinting. + These are classes that are encountered as intermediate results but should not be instantiated + directly by users. These classes are not to be confused with classes from the + `pandas-stubs `_ package + which has classes in addition to those that occur in pandas for type-hinting. In addition, public functions in ``pandas.io`` and ``pandas.tseries`` submodules are mentioned in the documentation.