Skip to content

Update comparison docs #18

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
eutwt merged 3 commits into from
Dec 31, 2025
Merged

Update comparison docs #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aab4494
Update comparison docs
eutwt Dec 31, 2025
0d6a4f5
Update website doc wording
eutwt Dec 31, 2025
f445a84
Document push timeout note
eutwt Dec 31, 2025
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: 2 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ future contributors can work without hunting through old context.
- Before pushing, run `scripts/pre_push.sh` (or symlink it into
`.git/hooks/pre-push`) so Ruff formatting, `pytest`, and `ty check`
finish successfully. The script aborts pushes if any step fails.
- Git pushes may require a higher timeout because the pre-push hook runs
Quarto, linting, tests, and type checks before the network step.
- The `README.md` Quick Start tables are rendered from `README.qmd` via
Quarto (do not edit them by hand). Whenever a change affects any helper
output (or periodically to keep outputs current), run
Expand Down
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,11 @@ comparison

A comparison includes:

- `comparison.intersection`: columns in both tables and rows with
- `comparison.intersection`: columns in both tables with counts of
differing values
- `comparison.unmatched_cols`: columns in only one table
- `comparison.unmatched_rows`: rows in only one table
- `comparison.unmatched_rows`: rows in only one table with counts per
table

Use `value_diffs()` to see the values that are different.

Expand Down
4 changes: 2 additions & 2 deletions README.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ comparison

A comparison includes:

- `comparison.intersection`: columns in both tables and rows with differing values
- `comparison.intersection`: columns in both tables with counts of differing values
- `comparison.unmatched_cols`: columns in only one table
- `comparison.unmatched_rows`: rows in only one table
- `comparison.unmatched_rows`: rows in only one table with counts per table

Use `value_diffs()` to see the values that are different.

Expand Down
4 changes: 2 additions & 2 deletions docs_api/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ Use `compare()` to create a comparison of two tables.

A comparison contains:

- `comparison.intersection`: columns in both tables and rows with differing values
- `comparison.intersection`: columns in both tables with counts of differing values
- `comparison.unmatched_cols`: columns in only one table
- `comparison.unmatched_rows`: rows in only one table
- `comparison.unmatched_rows`: rows in only one table with counts per table

.. code-block:: pycon

Expand Down