Skip to content

Commit 181ecef

Browse files
Merge remote-tracking branch 'origin/generalize-metrics-add-nullability' into delta-metrics
2 parents eb0fb48 + eb1c427 commit 181ecef

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

.readthedocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
version: 2
22
build:
3-
os: ubuntu-20.04
3+
os: ubuntu-24.04
44
tools:
55
python: mambaforge-latest
66
commands:

diffly/comparison.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -959,8 +959,9 @@ def summary(
959959
one in a :class:`~diffly.metrics.Metric` with a column selector to target
960960
other column types (e.g. ``Metric(fn, selector=cs.all())``).
961961
See :doc:`/api/metrics` for the full list of presets and the
962-
are computed; presets are not applied automatically. Prefer short labels
963-
— the summary has a fixed width and many or long labels degrade rendering.
962+
:data:`~diffly.metrics.MetricFn` type. When ``None`` (default), no metrics
963+
are computed; presets are not applied automatically. Prefer short labels —
964+
the summary has a fixed width and many or long labels degrade rendering.
964965
965966
Returns:
966967
A summary which can be printed or written to a file.

0 commit comments

Comments
 (0)