Skip to content

Commit 3518676

Browse files
authored
docs: Update resolution docstrings to reference truncate instead of round (#283)
1 parent 573b564 commit 3518676

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

dataframely/columns/datetime.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def __init__(
6060
max_exclusive: Like `max` but exclusive. May not be specified if `max`
6161
is specified and vice versa.
6262
resolution: The resolution that dates in the column must have. This uses the
63-
formatting language used by :mod:`polars` datetime `round` method.
63+
formatting language used by :mod:`polars` datetime `truncate` method.
6464
For example, a value `1mo` expects all dates to be on the first of the
6565
month. Note that this setting does *not* affect the storage resolution.
6666
check: A custom rule or multiple rules to run for this column. This can be:
@@ -183,7 +183,7 @@ def __init__(
183183
max_exclusive: Like `max` but exclusive. May not be specified if `max`
184184
is specified and vice versa.
185185
resolution: The resolution that times in the column must have. This uses the
186-
formatting language used by :mod:`polars` datetime `round` method.
186+
formatting language used by :mod:`polars` datetime `truncate` method.
187187
For example, a value `1h` expects all times to be full hours. Note
188188
that this setting does *not* affect the storage resolution.
189189
check: A custom rule or multiple rules to run for this column. This can be:
@@ -314,7 +314,7 @@ def __init__(
314314
max_exclusive: Like `max` but exclusive. May not be specified if `max`
315315
is specified and vice versa.
316316
resolution: The resolution that datetimes in the column must have. This uses
317-
the formatting language used by :mod:`polars` datetime `round` method.
317+
the formatting language used by :mod:`polars` datetime `truncate` method.
318318
For example, a value `1h` expects all datetimes to be full hours. Note
319319
that this setting does *not* affect the storage resolution.
320320
time_zone: The time zone that datetimes in the column must have. The time
@@ -459,7 +459,7 @@ def __init__(
459459
max_exclusive: Like `max` but exclusive. May not be specified if `max`
460460
is specified and vice versa.
461461
resolution: The resolution that durations in the column must have. This uses
462-
the formatting language used by :mod:`polars` datetime `round` method.
462+
the formatting language used by :mod:`polars` datetime `truncate` method.
463463
For example, a value `1h` expects all durations to be full hours. Note
464464
that this setting does *not* affect the storage resolution.
465465
check: A custom rule or multiple rules to run for this column. This can be:

0 commit comments

Comments
 (0)