Skip to content

docs: Update resolution docstrings to reference truncate instead of round #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
borchero merged 1 commit into from
Feb 20, 2026
Merged

docs: Update resolution docstrings to reference truncate instead of round #283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions dataframely/columns/datetime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def __init__(
max_exclusive: Like `max` but exclusive. May not be specified if `max`
is specified and vice versa.
resolution: The resolution that dates in the column must have. This uses the
formatting language used by :mod:`polars` datetime `round` method.
formatting language used by :mod:`polars` datetime `truncate` method.
For example, a value `1mo` expects all dates to be on the first of the
month. Note that this setting does *not* affect the storage resolution.
check: A custom rule or multiple rules to run for this column. This can be:
Expand Down Expand Up @@ -183,7 +183,7 @@ def __init__(
max_exclusive: Like `max` but exclusive. May not be specified if `max`
is specified and vice versa.
resolution: The resolution that times in the column must have. This uses the
formatting language used by :mod:`polars` datetime `round` method.
formatting language used by :mod:`polars` datetime `truncate` method.
For example, a value `1h` expects all times to be full hours. Note
that this setting does *not* affect the storage resolution.
check: A custom rule or multiple rules to run for this column. This can be:
Expand Down Expand Up @@ -314,7 +314,7 @@ def __init__(
max_exclusive: Like `max` but exclusive. May not be specified if `max`
is specified and vice versa.
resolution: The resolution that datetimes in the column must have. This uses
the formatting language used by :mod:`polars` datetime `round` method.
the formatting language used by :mod:`polars` datetime `truncate` method.
For example, a value `1h` expects all datetimes to be full hours. Note
that this setting does *not* affect the storage resolution.
time_zone: The time zone that datetimes in the column must have. The time
Expand Down Expand Up @@ -459,7 +459,7 @@ def __init__(
max_exclusive: Like `max` but exclusive. May not be specified if `max`
is specified and vice versa.
resolution: The resolution that durations in the column must have. This uses
the formatting language used by :mod:`polars` datetime `round` method.
the formatting language used by :mod:`polars` datetime `truncate` method.
For example, a value `1h` expects all durations to be full hours. Note
that this setting does *not* affect the storage resolution.
check: A custom rule or multiple rules to run for this column. This can be:
Expand Down
Loading