Skip to content

docs: Correct tolerance default attribution #58

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

Open
Hayden Anderson (haydena7) wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −1
Open

docs: Correct tolerance default attribution #58

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
2 changes: 1 addition & 1 deletion docs/guides/features/tolerances.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"source": [
"## Default behavior\n",
"\n",
"By default, `diffly` uses `abs_tol=1e-08` and `rel_tol=1e-05` for floating point comparisons, matching Python's `math.isclose` defaults. Temporal types (dates, datetimes) are compared exactly (`abs_tol_temporal=0`). This means tiny floating point rounding is automatically ignored, but even a one-second timestamp difference will be flagged.\n",
"By default, `diffly` uses `abs_tol=1e-08` and `rel_tol=1e-05` for floating point comparisons, matching the defaults of `polars.testing.assert_frame_equal` (note these are looser than the defaults of `polars.Expr.is_close` and Python's `math.isclose`). Temporal types (dates, datetimes) are compared exactly (`abs_tol_temporal=0`). This means tiny floating point rounding is automatically ignored, but even a one-second timestamp difference will be flagged.\n",
Comment thread
borchero marked this conversation as resolved.
"\n",
"In our scenario, the `total` column has some values that differ only at the 10th decimal place due to how the totals were calculated in each system:"
]
Expand Down
Loading