From 5edf58c60c6468d9a2784e848a49d50cbbed1fb9 Mon Sep 17 00:00:00 2001 From: Damiano Cangini Date: Tue, 24 Mar 2020 15:07:45 +0000 Subject: [PATCH 1/5] DOC: Fix capitalization among headings in documentation files (#32550) --- doc/source/development/policies.rst | 16 ++++++++-------- doc/source/development/roadmap.rst | 14 +++++++------- doc/source/ecosystem.rst | 2 +- .../comparison/comparison_with_sas.rst | 4 ++-- .../comparison/comparison_with_sql.rst | 10 +++++----- 5 files changed, 23 insertions(+), 23 deletions(-) diff --git a/doc/source/development/policies.rst b/doc/source/development/policies.rst index b7cc3db3ad260..64004feff29a0 100644 --- a/doc/source/development/policies.rst +++ b/doc/source/development/policies.rst @@ -6,12 +6,12 @@ Policies .. _policies.version: -Version Policy +Version policy ~~~~~~~~~~~~~~ .. versionchanged:: 1.0.0 -pandas uses a loose variant of semantic versioning (`SemVer`_) to govern +Pandas uses a loose variant of semantic versioning (`SemVer`_) to govern deprecations, API compatibility, and version numbering. A pandas release number is made up of ``MAJOR.MINOR.PATCH``. @@ -23,7 +23,7 @@ and how to migrate existing code to the new behavior. Whenever possible, a deprecation path will be provided rather than an outright breaking change. -pandas will introduce deprecations in **minor** releases. These deprecations +Pandas will introduce deprecations in **minor** releases. These deprecations will preserve the existing behavior while emitting a warning that provide guidance on: @@ -39,19 +39,19 @@ deprecation removed in the next next major release (2.0.0). .. note:: - pandas will sometimes make *behavior changing* bug fixes, as part of + Pandas will sometimes make *behavior changing* bug fixes, as part of minor or patch releases. Whether or not a change is a bug fix or an API-breaking change is a judgement call. We'll do our best, and we invite you to participate in development discussion on the issue tracker or mailing list. These policies do not apply to features marked as **experimental** in the documentation. -pandas may change the behavior of experimental features at any time. +Pandas may change the behavior of experimental features at any time. -Python Support +Python support ~~~~~~~~~~~~~~ -pandas will only drop support for specific Python versions (e.g. 3.6.x, 3.7.x) in +Pandas will only drop support for specific Python versions (e.g. 3.6.x, 3.7.x) in pandas **major** releases. -.. _SemVer: https://semver.org +.. _SemVer: https://semver.org \ No newline at end of file diff --git a/doc/source/development/roadmap.rst b/doc/source/development/roadmap.rst index e57ff82add278..e9cb5c44fa491 100644 --- a/doc/source/development/roadmap.rst +++ b/doc/source/development/roadmap.rst @@ -22,8 +22,8 @@ See :ref:`roadmap.evolution` for proposing changes to this document. Extensibility ------------- -pandas :ref:`extending.extension-types` allow for extending NumPy types with custom -data types and array storage. pandas uses extension types internally, and provides +Pandas :ref:`extending.extension-types` allow for extending NumPy types with custom +data types and array storage. Pandas uses extension types internally, and provides an interface for 3rd-party libraries to define their own custom data types. Many parts of pandas still unintentionally convert data to a NumPy array. @@ -71,7 +71,7 @@ Block manager rewrite We'd like to replace pandas current internal data structures (a collection of 1 or 2-D arrays) with a simpler collection of 1-D arrays. -pandas internal data model is quite complex. A DataFrame is made up of +Pandas internal data model is quite complex. A DataFrame is made up of one or more 2-dimensional "blocks", with one or more blocks per dtype. This collection of 2-D arrays is managed by the BlockManager. @@ -132,7 +132,7 @@ Some specific goals include Performance monitoring ---------------------- -pandas uses `airspeed velocity `__ to +Pandas uses `airspeed velocity `__ to monitor for performance regressions. ASV itself is a fabulous tool, but requires some additional work to be integrated into an open source project's workflow. @@ -152,10 +152,10 @@ We'd like to fund improvements and maintenance of these tools to .. _roadmap.evolution: -Roadmap Evolution +Roadmap evolution ----------------- -pandas continues to evolve. The direction is primarily determined by community +Pandas continues to evolve. The direction is primarily determined by community interest. Everyone is welcome to review existing items on the roadmap and to propose a new item. @@ -176,4 +176,4 @@ should be notified of the proposal. When there's agreement that an implementation would be welcome, the roadmap should be updated to include the summary and a -link to the discussion issue. +link to the discussion issue. \ No newline at end of file diff --git a/doc/source/ecosystem.rst b/doc/source/ecosystem.rst index b7e53b84f0e02..fd5e7c552fe0a 100644 --- a/doc/source/ecosystem.rst +++ b/doc/source/ecosystem.rst @@ -5,7 +5,7 @@ {{ header }} **************** -Pandas ecosystem +pandas ecosystem **************** Increasingly, packages are being built on top of pandas to address specific needs diff --git a/doc/source/getting_started/comparison/comparison_with_sas.rst b/doc/source/getting_started/comparison/comparison_with_sas.rst index 4e284fe7b5968..f12d97d1d0fde 100644 --- a/doc/source/getting_started/comparison/comparison_with_sas.rst +++ b/doc/source/getting_started/comparison/comparison_with_sas.rst @@ -698,7 +698,7 @@ In pandas this would be written as: tips.groupby(['sex', 'smoker']).first() -Other Considerations +Other considerations -------------------- Disk vs memory @@ -752,4 +752,4 @@ to interop data between SAS and pandas is to serialize to csv. Wall time: 14.6 s In [9]: %time df = pd.read_csv('big.csv') - Wall time: 4.86 s + Wall time: 4.86 s \ No newline at end of file diff --git a/doc/source/getting_started/comparison/comparison_with_sql.rst b/doc/source/getting_started/comparison/comparison_with_sql.rst index e3c8f8f5ccbcd..cc642e2a2d780 100644 --- a/doc/source/getting_started/comparison/comparison_with_sql.rst +++ b/doc/source/getting_started/comparison/comparison_with_sql.rst @@ -75,7 +75,7 @@ Filtering in SQL is done via a WHERE clause. LIMIT 5; DataFrames can be filtered in multiple ways; the most intuitive of which is using -:ref:`boolean indexing ` +`boolean indexing `_. .. ipython:: python @@ -388,10 +388,10 @@ In pandas, you can use :meth:`~pandas.concat` in conjunction with pd.concat([df1, df2]).drop_duplicates() -Pandas equivalents for some SQL analytic and aggregate functions +pandas equivalents for some SQL analytic and aggregate functions ---------------------------------------------------------------- -Top N rows with offset +Top n rows with offset ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: sql @@ -405,7 +405,7 @@ Top N rows with offset tips.nlargest(10 + 5, columns='tip').tail(10) -Top N rows per group +Top n rows per group ~~~~~~~~~~~~~~~~~~~~ .. code-block:: sql @@ -490,4 +490,4 @@ In pandas we select the rows that should remain, instead of deleting them .. ipython:: python - tips = tips.loc[tips['tip'] <= 9] + tips = tips.loc[tips['tip'] <= 9] \ No newline at end of file From b85219bc0852bd89e3e0c9597159a1e236f6dd98 Mon Sep 17 00:00:00 2001 From: themien Date: Tue, 24 Mar 2020 15:20:25 +0000 Subject: [PATCH 2/5] Update policies.rst --- doc/source/development/policies.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/development/policies.rst b/doc/source/development/policies.rst index 64004feff29a0..1031bbfc46457 100644 --- a/doc/source/development/policies.rst +++ b/doc/source/development/policies.rst @@ -11,7 +11,7 @@ Version policy .. versionchanged:: 1.0.0 -Pandas uses a loose variant of semantic versioning (`SemVer`_) to govern +pandas uses a loose variant of semantic versioning (`SemVer`_) to govern deprecations, API compatibility, and version numbering. A pandas release number is made up of ``MAJOR.MINOR.PATCH``. @@ -23,7 +23,7 @@ and how to migrate existing code to the new behavior. Whenever possible, a deprecation path will be provided rather than an outright breaking change. -Pandas will introduce deprecations in **minor** releases. These deprecations +pandas will introduce deprecations in **minor** releases. These deprecations will preserve the existing behavior while emitting a warning that provide guidance on: @@ -39,19 +39,19 @@ deprecation removed in the next next major release (2.0.0). .. note:: - Pandas will sometimes make *behavior changing* bug fixes, as part of + pandas will sometimes make *behavior changing* bug fixes, as part of minor or patch releases. Whether or not a change is a bug fix or an API-breaking change is a judgement call. We'll do our best, and we invite you to participate in development discussion on the issue tracker or mailing list. These policies do not apply to features marked as **experimental** in the documentation. -Pandas may change the behavior of experimental features at any time. +pandas may change the behavior of experimental features at any time. Python support ~~~~~~~~~~~~~~ -Pandas will only drop support for specific Python versions (e.g. 3.6.x, 3.7.x) in +pandas will only drop support for specific Python versions (e.g. 3.6.x, 3.7.x) in pandas **major** releases. -.. _SemVer: https://semver.org \ No newline at end of file +.. _SemVer: https://semver.org From 313b938a7eb15ede06999ceb8c99a32987108ec4 Mon Sep 17 00:00:00 2001 From: themien Date: Tue, 24 Mar 2020 15:21:23 +0000 Subject: [PATCH 3/5] Update roadmap.rst --- doc/source/development/roadmap.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/source/development/roadmap.rst b/doc/source/development/roadmap.rst index e9cb5c44fa491..b7943efa15a28 100644 --- a/doc/source/development/roadmap.rst +++ b/doc/source/development/roadmap.rst @@ -22,7 +22,7 @@ See :ref:`roadmap.evolution` for proposing changes to this document. Extensibility ------------- -Pandas :ref:`extending.extension-types` allow for extending NumPy types with custom +pandas :ref:`extending.extension-types` allow for extending NumPy types with custom data types and array storage. Pandas uses extension types internally, and provides an interface for 3rd-party libraries to define their own custom data types. @@ -71,7 +71,7 @@ Block manager rewrite We'd like to replace pandas current internal data structures (a collection of 1 or 2-D arrays) with a simpler collection of 1-D arrays. -Pandas internal data model is quite complex. A DataFrame is made up of +pandas internal data model is quite complex. A DataFrame is made up of one or more 2-dimensional "blocks", with one or more blocks per dtype. This collection of 2-D arrays is managed by the BlockManager. @@ -132,7 +132,7 @@ Some specific goals include Performance monitoring ---------------------- -Pandas uses `airspeed velocity `__ to +pandas uses `airspeed velocity `__ to monitor for performance regressions. ASV itself is a fabulous tool, but requires some additional work to be integrated into an open source project's workflow. @@ -155,7 +155,7 @@ We'd like to fund improvements and maintenance of these tools to Roadmap evolution ----------------- -Pandas continues to evolve. The direction is primarily determined by community +pandas continues to evolve. The direction is primarily determined by community interest. Everyone is welcome to review existing items on the roadmap and to propose a new item. @@ -176,4 +176,4 @@ should be notified of the proposal. When there's agreement that an implementation would be welcome, the roadmap should be updated to include the summary and a -link to the discussion issue. \ No newline at end of file +link to the discussion issue. From 120485b63f61e07d6000eb9b1cbdc851265c9f8c Mon Sep 17 00:00:00 2001 From: themien Date: Tue, 24 Mar 2020 15:23:06 +0000 Subject: [PATCH 4/5] Update roadmap.rst --- doc/source/development/roadmap.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/roadmap.rst b/doc/source/development/roadmap.rst index b7943efa15a28..d331491d02883 100644 --- a/doc/source/development/roadmap.rst +++ b/doc/source/development/roadmap.rst @@ -23,7 +23,7 @@ Extensibility ------------- pandas :ref:`extending.extension-types` allow for extending NumPy types with custom -data types and array storage. Pandas uses extension types internally, and provides +data types and array storage. pandas uses extension types internally, and provides an interface for 3rd-party libraries to define their own custom data types. Many parts of pandas still unintentionally convert data to a NumPy array. From 77a5e58fe9f9c94b2c7c70b0a188bc09020b7b6e Mon Sep 17 00:00:00 2001 From: themien Date: Tue, 24 Mar 2020 15:26:41 +0000 Subject: [PATCH 5/5] Update comparison_with_sql.rst --- doc/source/getting_started/comparison/comparison_with_sql.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/getting_started/comparison/comparison_with_sql.rst b/doc/source/getting_started/comparison/comparison_with_sql.rst index cc642e2a2d780..c46ec9b3f7090 100644 --- a/doc/source/getting_started/comparison/comparison_with_sql.rst +++ b/doc/source/getting_started/comparison/comparison_with_sql.rst @@ -75,7 +75,7 @@ Filtering in SQL is done via a WHERE clause. LIMIT 5; DataFrames can be filtered in multiple ways; the most intuitive of which is using -`boolean indexing `_. +:ref:`boolean indexing ` .. ipython:: python @@ -490,4 +490,4 @@ In pandas we select the rows that should remain, instead of deleting them .. ipython:: python - tips = tips.loc[tips['tip'] <= 9] \ No newline at end of file + tips = tips.loc[tips['tip'] <= 9]