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

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 5b368602fe
Signed by: louis9902
GPG key ID: 4B9DB28F826553BD
3 changed files with 39 additions and 3 deletions

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
### Fixed
- **request.result:** Correct the namespace in the `Prelude` doc comment (`Geekeey.Extensions.Result``Geekeey.Request.Result`)