From b3a3dfaa8d89cab14731b16ae9e943336ca9da8e Mon Sep 17 00:00:00 2001
From: Nitish Satyavolu <snitish.iitk@gmail.com>
Date: Fri, 7 Mar 2025 20:57:02 -0800
Subject: [PATCH 1/4] DOC: Add doc for half year offsets
---
doc/source/reference/offset_frequency.rst | 140 ++++++++++++++++++++++
doc/source/user_guide/timeseries.rst | 4 +
2 files changed, 144 insertions(+)
diff --git a/doc/source/reference/offset_frequency.rst b/doc/source/reference/offset_frequency.rst
index 8bb2c6ffe73be..54bc2ea26f901 100644
--- a/doc/source/reference/offset_frequency.rst
+++ b/doc/source/reference/offset_frequency.rst
@@ -776,6 +776,146 @@ Methods
QuarterBegin.is_year_start
QuarterBegin.is_year_end
+BHalfYearEnd
+-----------
+.. autosummary::
+ :toctree: api/
+
+ BHalfYearEnd
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+ :toctree: api/
+
+ BHalfYearEnd.freqstr
+ BHalfYearEnd.kwds
+ BHalfYearEnd.name
+ BHalfYearEnd.nanos
+ BHalfYearEnd.normalize
+ BHalfYearEnd.rule_code
+ BHalfYearEnd.n
+ BHalfYearEnd.startingMonth
+
+Methods
+~~~~~~~
+.. autosummary::
+ :toctree: api/
+
+ BHalfYearEnd.copy
+ BHalfYearEnd.is_on_offset
+ BHalfYearEnd.is_month_start
+ BHalfYearEnd.is_month_end
+ BHalfYearEnd.is_quarter_start
+ BHalfYearEnd.is_quarter_end
+ BHalfYearEnd.is_year_start
+ BHalfYearEnd.is_year_end
+
+BHalfYearBegin
+-------------
+.. autosummary::
+ :toctree: api/
+
+ BHalfYearBegin
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+ :toctree: api/
+
+ BHalfYearBegin.freqstr
+ BHalfYearBegin.kwds
+ BHalfYearBegin.name
+ BHalfYearBegin.nanos
+ BHalfYearBegin.normalize
+ BHalfYearBegin.rule_code
+ BHalfYearBegin.n
+ BHalfYearBegin.startingMonth
+
+Methods
+~~~~~~~
+.. autosummary::
+ :toctree: api/
+
+ BHalfYearBegin.copy
+ BHalfYearBegin.is_on_offset
+ BHalfYearBegin.is_month_start
+ BHalfYearBegin.is_month_end
+ BHalfYearBegin.is_quarter_start
+ BHalfYearBegin.is_quarter_end
+ BHalfYearBegin.is_year_start
+ BHalfYearBegin.is_year_end
+
+HalfYearEnd
+----------
+.. autosummary::
+ :toctree: api/
+
+ HalfYearEnd
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+ :toctree: api/
+
+ HalfYearEnd.freqstr
+ HalfYearEnd.kwds
+ HalfYearEnd.name
+ HalfYearEnd.nanos
+ HalfYearEnd.normalize
+ HalfYearEnd.rule_code
+ HalfYearEnd.n
+ HalfYearEnd.startingMonth
+
+Methods
+~~~~~~~
+.. autosummary::
+ :toctree: api/
+
+ HalfYearEnd.copy
+ HalfYearEnd.is_on_offset
+ HalfYearEnd.is_month_start
+ HalfYearEnd.is_month_end
+ HalfYearEnd.is_quarter_start
+ HalfYearEnd.is_quarter_end
+ HalfYearEnd.is_year_start
+ HalfYearEnd.is_year_end
+
+HalfYearBegin
+------------
+.. autosummary::
+ :toctree: api/
+
+ HalfYearBegin
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+ :toctree: api/
+
+ HalfYearBegin.freqstr
+ HalfYearBegin.kwds
+ HalfYearBegin.name
+ HalfYearBegin.nanos
+ HalfYearBegin.normalize
+ HalfYearBegin.rule_code
+ HalfYearBegin.n
+ HalfYearBegin.startingMonth
+
+Methods
+~~~~~~~
+.. autosummary::
+ :toctree: api/
+
+ HalfYearBegin.copy
+ HalfYearBegin.is_on_offset
+ HalfYearBegin.is_month_start
+ HalfYearBegin.is_month_end
+ HalfYearBegin.is_quarter_start
+ HalfYearBegin.is_quarter_end
+ HalfYearBegin.is_year_start
+ HalfYearBegin.is_year_end
+
BYearEnd
--------
.. autosummary::
diff --git a/doc/source/user_guide/timeseries.rst b/doc/source/user_guide/timeseries.rst
index d046d13f71daf..be03ec590784c 100644
--- a/doc/source/user_guide/timeseries.rst
+++ b/doc/source/user_guide/timeseries.rst
@@ -891,6 +891,10 @@ into ``freq`` keyword arguments. The available date offsets and associated frequ
:class:`~pandas.tseries.offsets.BQuarterEnd`, ``'BQE``, "business quarter end"
:class:`~pandas.tseries.offsets.BQuarterBegin`, ``'BQS'``, "business quarter begin"
:class:`~pandas.tseries.offsets.FY5253Quarter`, ``'REQ'``, "retail (aka 52-53 week) quarter"
+ :class:`~pandas.tseries.offsets.HalfYearEnd`, ``'QE'``, "calendar half year end"
+ :class:`~pandas.tseries.offsets.HalfYearBegin`, ``'QS'``, "calendar half year begin"
+ :class:`~pandas.tseries.offsets.BHalfYearEnd`, ``'BQE``, "business half year end"
+ :class:`~pandas.tseries.offsets.BHalfYearBegin`, ``'BQS'``, "business half year begin"
:class:`~pandas.tseries.offsets.YearEnd`, ``'YE'``, "calendar year end"
:class:`~pandas.tseries.offsets.YearBegin`, ``'YS'`` or ``'BYS'``,"calendar year begin"
:class:`~pandas.tseries.offsets.BYearEnd`, ``'BYE'``, "business year end"
From 2eae621911d50b8f18efc9bcbe5320d9290bcaed Mon Sep 17 00:00:00 2001
From: Nitish Satyavolu <snitish.iitk@gmail.com>
Date: Fri, 7 Mar 2025 21:01:05 -0800
Subject: [PATCH 2/4] Fix freq strings
---
doc/source/user_guide/timeseries.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/doc/source/user_guide/timeseries.rst b/doc/source/user_guide/timeseries.rst
index be03ec590784c..10260cb011d90 100644
--- a/doc/source/user_guide/timeseries.rst
+++ b/doc/source/user_guide/timeseries.rst
@@ -891,10 +891,10 @@ into ``freq`` keyword arguments. The available date offsets and associated frequ
:class:`~pandas.tseries.offsets.BQuarterEnd`, ``'BQE``, "business quarter end"
:class:`~pandas.tseries.offsets.BQuarterBegin`, ``'BQS'``, "business quarter begin"
:class:`~pandas.tseries.offsets.FY5253Quarter`, ``'REQ'``, "retail (aka 52-53 week) quarter"
- :class:`~pandas.tseries.offsets.HalfYearEnd`, ``'QE'``, "calendar half year end"
- :class:`~pandas.tseries.offsets.HalfYearBegin`, ``'QS'``, "calendar half year begin"
- :class:`~pandas.tseries.offsets.BHalfYearEnd`, ``'BQE``, "business half year end"
- :class:`~pandas.tseries.offsets.BHalfYearBegin`, ``'BQS'``, "business half year begin"
+ :class:`~pandas.tseries.offsets.HalfYearEnd`, ``'HYE'``, "calendar half year end"
+ :class:`~pandas.tseries.offsets.HalfYearBegin`, ``'HYS'``, "calendar half year begin"
+ :class:`~pandas.tseries.offsets.BHalfYearEnd`, ``'BHYE``, "business half year end"
+ :class:`~pandas.tseries.offsets.BHalfYearBegin`, ``'BHYS'``, "business half year begin"
:class:`~pandas.tseries.offsets.YearEnd`, ``'YE'``, "calendar year end"
:class:`~pandas.tseries.offsets.YearBegin`, ``'YS'`` or ``'BYS'``,"calendar year begin"
:class:`~pandas.tseries.offsets.BYearEnd`, ``'BYE'``, "business year end"
From 4f866d219643072b3021def5275b9d138ec095de Mon Sep 17 00:00:00 2001
From: Nitish Satyavolu <snitish.iitk@gmail.com>
Date: Fri, 7 Mar 2025 21:22:44 -0800
Subject: [PATCH 3/4] Fix docstring error
---
doc/source/reference/offset_frequency.rst | 8 ++++----
scripts/validate_rst_title_capitalization.py | 5 +++++
2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/doc/source/reference/offset_frequency.rst b/doc/source/reference/offset_frequency.rst
index 54bc2ea26f901..5876e005574fd 100644
--- a/doc/source/reference/offset_frequency.rst
+++ b/doc/source/reference/offset_frequency.rst
@@ -777,7 +777,7 @@ Methods
QuarterBegin.is_year_end
BHalfYearEnd
------------
+------------
.. autosummary::
:toctree: api/
@@ -812,7 +812,7 @@ Methods
BHalfYearEnd.is_year_end
BHalfYearBegin
--------------
+--------------
.. autosummary::
:toctree: api/
@@ -847,7 +847,7 @@ Methods
BHalfYearBegin.is_year_end
HalfYearEnd
-----------
+-----------
.. autosummary::
:toctree: api/
@@ -882,7 +882,7 @@ Methods
HalfYearEnd.is_year_end
HalfYearBegin
-------------
+-------------
.. autosummary::
:toctree: api/
diff --git a/scripts/validate_rst_title_capitalization.py b/scripts/validate_rst_title_capitalization.py
index 44318cd797163..73a90f4fca0f6 100755
--- a/scripts/validate_rst_title_capitalization.py
+++ b/scripts/validate_rst_title_capitalization.py
@@ -92,6 +92,11 @@
"BYearBegin",
"BYearEnd",
"YearOffset",
+ "HalfYearBegin",
+ "HalfYearEnd",
+ "BHalfYearBegin",
+ "BHalfYearEnd",
+ "HalfYearOffset",
"QuarterBegin",
"QuarterEnd",
"BQuarterBegin",
From 0a22378d9132d95202e43676dca229b45a7d0179 Mon Sep 17 00:00:00 2001
From: Nitish Satyavolu <snitish.iitk@gmail.com>
Date: Sat, 8 Mar 2025 12:48:13 -0800
Subject: [PATCH 4/4] Fix more docstring errors
---
ci/code_checks.sh | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
index 5782b2b171e07..6ce43725fecc9 100755
--- a/ci/code_checks.sh
+++ b/ci/code_checks.sh
@@ -83,6 +83,16 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
-i "pandas.core.resample.Resampler.quantile PR01,PR07" \
-i "pandas.tseries.offsets.BDay PR02,SA01" \
+ -i "pandas.tseries.offsets.BHalfYearBegin.is_on_offset GL08" \
+ -i "pandas.tseries.offsets.BHalfYearBegin.n GL08" \
+ -i "pandas.tseries.offsets.BHalfYearBegin.normalize GL08" \
+ -i "pandas.tseries.offsets.BHalfYearBegin.rule_code GL08" \
+ -i "pandas.tseries.offsets.BHalfYearBegin.startingMonth GL08" \
+ -i "pandas.tseries.offsets.BHalfYearEnd.is_on_offset GL08" \
+ -i "pandas.tseries.offsets.BHalfYearEnd.n GL08" \
+ -i "pandas.tseries.offsets.BHalfYearEnd.normalize GL08" \
+ -i "pandas.tseries.offsets.BHalfYearEnd.rule_code GL08" \
+ -i "pandas.tseries.offsets.BHalfYearEnd.startingMonth GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.n GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.normalize GL08" \
@@ -185,6 +195,16 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.FY5253Quarter.variation GL08" \
-i "pandas.tseries.offsets.FY5253Quarter.weekday GL08" \
-i "pandas.tseries.offsets.FY5253Quarter.year_has_extra_week GL08" \
+ -i "pandas.tseries.offsets.HalfYearBegin.is_on_offset GL08" \
+ -i "pandas.tseries.offsets.HalfYearBegin.n GL08" \
+ -i "pandas.tseries.offsets.HalfYearBegin.normalize GL08" \
+ -i "pandas.tseries.offsets.HalfYearBegin.rule_code GL08" \
+ -i "pandas.tseries.offsets.HalfYearBegin.startingMonth GL08" \
+ -i "pandas.tseries.offsets.HalfYearEnd.is_on_offset GL08" \
+ -i "pandas.tseries.offsets.HalfYearEnd.n GL08" \
+ -i "pandas.tseries.offsets.HalfYearEnd.normalize GL08" \
+ -i "pandas.tseries.offsets.HalfYearEnd.rule_code GL08" \
+ -i "pandas.tseries.offsets.HalfYearEnd.startingMonth GL08" \
-i "pandas.tseries.offsets.Hour.is_on_offset GL08" \
-i "pandas.tseries.offsets.Hour.n GL08" \
-i "pandas.tseries.offsets.Hour.normalize GL08" \