From 9c9468fa3c1a18a8e6980c90407116237532bf1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20M=C3=BCller?= Date: Wed, 23 Sep 2026 22:11:22 +0000 Subject: [PATCH] :memo: Explain the W widening suffix in the API section State that the `W` suffix means widening and what that widens: the matcher's return value goes from one common `R` to the union of every handler's return type. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index edc9eea..475c998 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,8 @@ for the design decisions and [Caveats](#caveats) for the limits. The package exports four factories and the builder types they return. Each factory comes in a _strict_ variant (one common return type `R`) and a -_widening_ variant (the union of every handler's return type): +_widening_ variant: the `W` suffix means **widening** — the return value is +widened from one common `R` to the union of every handler's return type. | Factory | Builder type | Return of the matcher | | -------------------------------- | ------------------------------- | -------------------------------- |