geekeey/request
Watch
2
0
Fork
You've already forked request
 0
Code Issues Pull requests Projects Releases Packages 3 Wiki Activity Actions

docs(result): document that failure equality ignores error content

Browse source 
Result/Result<T> equality treats any two failures as equal regardless of their
Error, which was undocumented and surprising for failure-specific branching.
This commit is contained in:
Louis Seubert 2026-07-12 18:35:50 +02:00
commit ab9407085d
Signed by: louis9902
GPG key ID: 4B9DB28F826553BD
3 changed files with 39 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -45,6 +45,8 @@ To have a consistent experience across all packages, some public interfaces have
### Changed
- **request.result:** Document that `Result`/`Result<T>` equality treats any two failures as equal, ignoring error content; branch on the `Error` directly for failure-specific logic (see PLAN.md Inconsistencies#E)
### Fixed
- **request.result:** Correct the namespace in the `Prelude` doc comment (`Geekeey.Extensions.Result` → `Geekeey.Request.Result`)