Skip to content

Commit b8c5932

Browse files
authored
docs: require vortex_ensure_eq for equality checks (#11246)
## Summary Equality failures are easier to diagnose when errors include both values. Agent guidance should require `vortex_ensure_eq!` whenever possible so new equality checks include those diagnostics. ## Changes Added the rule to the Rust code style guidance in `AGENTS.md`. Signed-off-by: Connor Tsui <[email protected]>
1 parent 068d819 commit b8c5932

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,8 @@ These CI checks are the ones most often missed when adding files rather than edi
191191
per-element loops; back such changes with the benchmarks it names.
192192
- Only write comments that explain non-obvious logic or important context. Do not comment
193193
self-explanatory code.
194+
- Use `vortex_ensure_eq!(left, right)` instead of `vortex_ensure!(left == right)` whenever
195+
possible so equality failures report both values.
194196

195197
## Tests
196198

0 commit comments

Comments
 (0)