diff --git a/AGENTS.md b/AGENTS.md index cb75a35..937a7d8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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 diff --git a/README.md b/README.md index c060e7d..cd7bec6 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/README.qmd b/README.qmd index 7a81a6b..59a173a 100644 --- a/README.qmd +++ b/README.qmd @@ -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. diff --git a/docs_api/source/index.rst b/docs_api/source/index.rst index 513e086..a4ac245 100644 --- a/docs_api/source/index.rst +++ b/docs_api/source/index.rst @@ -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