From aa4b621172f2710cdb970e10248d669c5d9b5e0e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=93scar=20G=C3=B3mez?= <oscar.gomez.borz@gmail.com>
Date: Tue, 3 Dec 2024 19:39:25 +0100
Subject: [PATCH] DOC: Fix some docstring validations in pd.Series (#60481)
* DOC: Fix some docstring validations in pd.Series
* new circle
---
ci/code_checks.sh | 2 --
pandas/core/arrays/datetimelike.py | 24 +++++++++++++++++++++++-
2 files changed, 23 insertions(+), 3 deletions(-)
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
index dde98a01cc..a21b87950c 100755
--- a/ci/code_checks.sh
+++ b/ci/code_checks.sh
@@ -73,8 +73,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Period.freq GL08" \
-i "pandas.Period.ordinal GL08" \
-i "pandas.RangeIndex.from_range PR01,SA01" \
- -i "pandas.Series.dt.unit GL08" \
- -i "pandas.Series.pad PR01,SA01" \
-i "pandas.Timedelta.max PR02" \
-i "pandas.Timedelta.min PR02" \
-i "pandas.Timedelta.resolution PR02" \
diff --git a/pandas/core/arrays/datetimelike.py b/pandas/core/arrays/datetimelike.py
index 9c821bf0d1..c6b6367e34 100644
--- a/pandas/core/arrays/datetimelike.py
+++ b/pandas/core/arrays/datetimelike.py
@@ -2073,7 +2073,29 @@ class TimelikeOps(DatetimeLikeArrayMixin):
@cache_readonly
def unit(self) -> str:
- # e.g. "ns", "us", "ms"
+ """
+ The precision unit of the datetime data.
+
+ Returns the precision unit for the dtype.
+ It means the smallest time frame that can be stored within this dtype.
+
+ Returns
+ -------
+ str
+ Unit string representation (e.g. "ns").
+
+ See Also
+ --------
+ TimelikeOps.as_unit : Converts to a specific unit.
+
+ Examples
+ --------
+ >>> idx = pd.DatetimeIndex(["2020-01-02 01:02:03.004005006"])
+ >>> idx.unit
+ 'ns'
+ >>> idx.as_unit("s").unit
+ 's'
+ """
# error: Argument 1 to "dtype_to_unit" has incompatible type
# "ExtensionDtype"; expected "Union[DatetimeTZDtype, dtype[Any]]"
return dtype_to_unit(self.dtype) # type: ignore[arg-type]
--
GitLab