Merge remote-tracking branch 'upstream/master' into DOC-DocTests-core-groupby

Author: MomIsBestFriend

ci/code_checks.sh

@@ -266,57 +266,62 @@ fi
 ### DOCTESTS ###
 if [[ -z "$CHECK" || "$CHECK" == "doctests" ]]; then
 
+    # Individual files
+
+    MSG='Doctests base.py' ; echo $MSG
+    pytest -q --doctest-modules pandas/core/base.py
+    RET=$(($RET + $?)) ; echo $MSG "DONE"
+
+    MSG='Doctests construction.py' ; echo $MSG
+    pytest -q --doctest-modules pandas/core/construction.py
+    RET=$(($RET + $?)) ; echo $MSG "DONE"
+
     MSG='Doctests frame.py' ; echo $MSG
     pytest -q --doctest-modules pandas/core/frame.py
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
-    MSG='Doctests series.py' ; echo $MSG
-    pytest -q --doctest-modules pandas/core/series.py
+    MSG='Doctests generic.py' ; echo $MSG
+    pytest -q --doctest-modules pandas/core/generic.py
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
     MSG='Doctests groupby' ; echo $MSG
     pytest -q --doctest-modules pandas/core/groupby/
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
-    MSG='Doctests tools' ; echo $MSG
-    pytest -q --doctest-modules pandas/core/tools/
-    RET=$(($RET + $?)) ; echo $MSG "DONE"
-
-    MSG='Doctests reshaping functions' ; echo $MSG
-    pytest -q --doctest-modules pandas/core/reshape/
+    MSG='Doctests series.py' ; echo $MSG
+    pytest -q --doctest-modules pandas/core/series.py
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
-    MSG='Doctests interval classes' ; echo $MSG
-    pytest -q --doctest-modules pandas/core/indexes/interval.py
-    RET=$(($RET + $?)) ; echo $MSG "DONE"
+    # Directories
 
     MSG='Doctests arrays'; echo $MSG
     pytest -q --doctest-modules pandas/core/arrays/
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
+    MSG='Doctests computation' ; echo $MSG
+    pytest -q --doctest-modules pandas/core/computation/
+    RET=$(($RET + $?)) ; echo $MSG "DONE"
+
     MSG='Doctests dtypes'; echo $MSG
     pytest -q --doctest-modules pandas/core/dtypes/
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
-    MSG='Doctests base.py' ; echo $MSG
-    pytest -q --doctest-modules pandas/core/base.py
+    MSG='Doctests indexes' ; echo $MSG
+    pytest -q --doctest-modules pandas/core/indexes/
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
-    MSG='Doctests construction.py' ; echo $MSG
-    pytest -q --doctest-modules pandas/core/construction.py
+    MSG='Doctests reshaping functions' ; echo $MSG
+    pytest -q --doctest-modules pandas/core/reshape/
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
-    MSG='Doctests generic.py' ; echo $MSG
-    pytest -q --doctest-modules pandas/core/generic.py
+    MSG='Doctests tools' ; echo $MSG
+    pytest -q --doctest-modules pandas/core/tools/
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
     MSG='Doctests tseries' ; echo $MSG
     pytest -q --doctest-modules pandas/tseries/
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
-    MSG='Doctests computation' ; echo $MSG
-    pytest -q --doctest-modules pandas/core/computation/
-    RET=$(($RET + $?)) ; echo $MSG "DONE"
 fi
 
 ### DOCSTRINGS ###
@@ -327,7 +332,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
     MSG='Validate correct capitalization among titles in documentation' ; echo $MSG
-    $BASE_DIR/scripts/validate_rst_title_capitalization.py $BASE_DIR/doc/source/development/contributing.rst
+    $BASE_DIR/scripts/validate_rst_title_capitalization.py $BASE_DIR/doc/source/development/contributing.rst $BASE_DIR/doc/source/reference
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
 fi

doc/source/development/code_style.rst

@@ -18,8 +18,8 @@ consistent code format throughout the project. For details see the
 Patterns
 ========
 
-foo.__class__
--------------
+Using foo.__class__
+-------------------
 
 
 pandas uses 'type(foo)' instead 'foo.__class__' as it is making the code more
@@ -47,8 +47,8 @@ String formatting
 Concatenated strings
 --------------------
 
-f-strings
-~~~~~~~~~
+Using f-strings
+~~~~~~~~~~~~~~~
 
 pandas uses f-strings formatting instead of '%' and '.format()' string formatters.
 

doc/source/development/contributing.rst

@@ -295,7 +295,7 @@ Below is a brief overview on how to set-up a virtual environment with Powershell
 under Windows. For details please refer to the
 `official virtualenv user guide <https://virtualenv.pypa.io/en/stable/userguide/#activate-script>`__
 
-Use an ENV_DIR of your choice. We'll use ~\virtualenvs\pandas-dev where
+Use an ENV_DIR of your choice. We'll use ~\\virtualenvs\\pandas-dev where
 '~' is the folder pointed to by either $env:USERPROFILE (Powershell) or
 %USERPROFILE% (cmd.exe) environment variable. Any parent directories
 should already exist.

doc/source/development/extending.rst

@@ -139,7 +139,7 @@ and comments contain guidance for properly implementing the interface.
 
 .. _extending.extension.operator:
 
-:class:`~pandas.api.extensions.ExtensionArray` Operator Support
+:class:`~pandas.api.extensions.ExtensionArray` operator support
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. versionadded:: 0.24.0

doc/source/development/policies.rst

@@ -6,7 +6,7 @@ Policies
 
 .. _policies.version:
 
-Version Policy
+Version policy
 ~~~~~~~~~~~~~~
 
 .. versionchanged:: 1.0.0
@@ -48,7 +48,7 @@ deprecation removed in the next next major release (2.0.0).
 These policies do not apply to features marked as **experimental** in the documentation.
 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

doc/source/development/roadmap.rst

@@ -152,7 +152,7 @@ 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

doc/source/getting_started/intro_tutorials/09_timeseries.rst

@@ -96,7 +96,7 @@ objects. In pandas we call these datetime objects similar to
 
         pd.read_csv("../data/air_quality_no2_long.csv", parse_dates=["datetime"])
 
-Why are these :class:`pandas.Timestamp` objects useful. Let’s illustrate the added
+Why are these :class:`pandas.Timestamp` objects useful? Let’s illustrate the added
 value with some example cases.
 
    What is the start and end date of the time series data set working
@@ -106,7 +106,7 @@ value with some example cases.
 
     air_quality["datetime"].min(), air_quality["datetime"].max()
 
-Using :class:`pandas.Timestamp` for datetimes enable us to calculate with date
+Using :class:`pandas.Timestamp` for datetimes enables us to calculate with date
 information and make them comparable. Hence, we can use this to get the
 length of our time series:
 
@@ -122,7 +122,7 @@ from the standard Python library and defining a time duration.
     <div class="d-flex flex-row gs-torefguide">
         <span class="badge badge-info">To user guide</span>
 
-The different time concepts supported by pandas are explained in the user guide section on :ref:`time related concepts <timeseries.overview>`.
+The various time concepts supported by pandas are explained in the user guide section on :ref:`time related concepts <timeseries.overview>`.
 
 .. raw:: html
 
@@ -157,7 +157,7 @@ accessible by the ``dt`` accessor.
 
 An overview of the existing date properties is given in the
 :ref:`time and date components overview table <timeseries.components>`. More details about the ``dt`` accessor
-to return datetime like properties is explained in a dedicated section on the  :ref:`dt accessor <basics.dt_accessors>`.
+to return datetime like properties are explained in a dedicated section on the  :ref:`dt accessor <basics.dt_accessors>`.
 
 .. raw:: html
 
@@ -353,7 +353,7 @@ Make a plot of the daily mean :math:`NO_2` value in each of the stations.
     <div class="d-flex flex-row gs-torefguide">
         <span class="badge badge-info">To user guide</span>
 
-More details on the power of time series ``resampling`` is provided in the user gudie section on :ref:`resampling <timeseries.resampling>`.
+More details on the power of time series ``resampling`` is provided in the user guide section on :ref:`resampling <timeseries.resampling>`.
 
 .. raw:: html
 
@@ -366,7 +366,7 @@ More details on the power of time series ``resampling`` is provided in the user
 
 -  Valid date strings can be converted to datetime objects using
    ``to_datetime`` function or as part of read functions.
--  Datetime objects in pandas supports calculations, logical operations
+-  Datetime objects in pandas support calculations, logical operations
    and convenient date-related properties using the ``dt`` accessor.
 -  A ``DatetimeIndex`` contains these date-related properties and
    supports convenient slicing.
@@ -382,7 +382,7 @@ More details on the power of time series ``resampling`` is provided in the user
     <div class="d-flex flex-row gs-torefguide">
         <span class="badge badge-info">To user guide</span>
 
-A full overview on time series is given in the pages on :ref:`time series and date functionality <timeseries>`.
+A full overview on time series is given on the pages on :ref:`time series and date functionality <timeseries>`.
 
 .. raw:: html
 

doc/source/reference/frame.rst

@@ -251,7 +251,7 @@ Combining / joining / merging
    DataFrame.merge
    DataFrame.update
 
-Time series-related
+Time Series-related
 ~~~~~~~~~~~~~~~~~~~
 .. autosummary::
    :toctree: api/

doc/source/reference/indexing.rst

@@ -328,7 +328,7 @@ DatetimeIndex
 
    DatetimeIndex
 
-Time/Date components
+Time/date components
 ~~~~~~~~~~~~~~~~~~~~
 .. autosummary::
    :toctree: api/

doc/source/reference/series.rst

@@ -110,7 +110,7 @@ Binary operator functions
    Series.product
    Series.dot
 
-Function application, groupby & window
+Function application, GroupBy & window
 --------------------------------------
 .. autosummary::
    :toctree: api/
@@ -249,7 +249,7 @@ Combining / joining / merging
    Series.replace
    Series.update
 
-Time series-related
+Time Series-related
 -------------------
 .. autosummary::
    :toctree: api/