Skip to content

Commit 6b04f77

Browse files
committed
clarify
1 parent a43ad4a commit 6b04f77

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

spec/API_specification/column_object.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,3 @@ behavior.
1010
.. currentmodule:: dataframe_api
1111

1212
.. autoclass:: Column
13-
14-
.. autoclass:: DatetimeAccessor

spec/API_specification/dataframe_api/column_object.py

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -901,7 +901,7 @@ def iso_weekday(self) -> Self:
901901
"""
902902
...
903903

904-
def floor(self, frequency: str) -> Column:
904+
def floor(self, frequency: str) -> Self:
905905
"""
906906
Return floor of each element according to the specified frequency.
907907
@@ -922,12 +922,22 @@ def floor(self, frequency: str) -> Column:
922922
Frequency to floor by. Can be constructed using the following string
923923
language:
924924
925+
- "<n>day(s)"
926+
- "<n>hour(s)"
927+
- "<n>minute(s)"
928+
- "<n>second(s)"
929+
- "<n>millisecond(s)"
930+
- "<n>microsecond(s)"
931+
932+
where ``<n>`` is a positive integer and the trailing (s) is
933+
optional.
934+
Multiple frequencies can be specified, separated by blank spaces.
935+
936+
Examples of valid inputs are:
937+
925938
- "1day"
926-
- "1hour"
927-
- "1minute"
928-
- "1second"
929-
- "1millisecond"
930-
- "1microsecond"
939+
- "1day 1hour"
940+
- "1day 2hours 3minutes 4seconds 5milliseconds 6microseconds"
931941
932942
Examples
933943
--------
@@ -936,3 +946,4 @@ def floor(self, frequency: str) -> Column:
936946
>>> column: Column
937947
>>> column.dt.floor("1day")
938948
"""
949+
...

0 commit comments

Comments
 (0)