DOC: Updating capitalization development and reference directories (#33121)

Author: cleconte987

ci/code_checks.sh

@@ -327,7 +327,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/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/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/

scripts/validate_rst_title_capitalization.py

@@ -45,6 +45,60 @@
     "NumFOCUS",
     "sklearn",
     "Docker",
+    "PeriodIndex",
+    "NA",
+    "NaN",
+    "ValueError",
+    "BooleanArray",
+    "KeyError",
+    "API",
+    "FAQ",
+    "IO",
+    "TimedeltaIndex",
+    "DatetimeIndex",
+    "IntervalIndex",
+    "CategoricalIndex",
+    "GroupBy",
+    "SPSS",
+    "ORC",
+    "R",
+    "HDF5",
+    "HDFStore",
+    "CDay",
+    "CBMonthBegin",
+    "CBMonthEnd",
+    "BMonthBegin",
+    "BMonthEnd",
+    "BDay",
+    "FY5253Quarter",
+    "FY5253",
+    "YearBegin",
+    "YearEnd",
+    "BYearBegin",
+    "BYearEnd",
+    "YearOffset",
+    "QuarterBegin",
+    "QuarterEnd",
+    "BQuarterBegin",
+    "BQuarterEnd",
+    "QuarterOffset",
+    "LastWeekOfMonth",
+    "WeekOfMonth",
+    "SemiMonthBegin",
+    "SemiMonthEnd",
+    "SemiMonthOffset",
+    "CustomBusinessMonthBegin",
+    "CustomBusinessMonthEnd",
+    "BusinessMonthBegin",
+    "BusinessMonthEnd",
+    "MonthBegin",
+    "MonthEnd",
+    "MonthOffset",
+    "CustomBusinessHour",
+    "CustomBusinessDay",
+    "BusinessHour",
+    "BusinessDay",
+    "DateOffset",
 }
 
 CAP_EXCEPTIONS_DICT = {word.lower(): word for word in CAPITALIZATION_EXCEPTIONS}
@@ -69,6 +123,11 @@ def correct_title_capitalization(title: str) -> str:
         Correctly capitalized heading.
     """
 
+    # Skip modification no matter what if title begins by ":" to exclude specific
+    # syntax that is needed to build links.
+    if title[0] == ":":
+        return title
+
     # Strip all non-word characters from the beginning of the title to the
     # first word character.
     correct_title: str = re.sub(r"^\W*", "", title).capitalize()