docs: fix inaccuracies in ADDING_EVALS.md - #162
Open
sanchitmehtagit wants to merge 1 commit into
Open
Conversation
Corrects five claims that no longer match the framework code: - setup_command: supports `&&`-chained sub-commands (used by the flask/fastapi evals via runSetupCommand), not "one command only". - notContainsInSource: list the full non-source extension set it skips (.env*, .json, .plist, .xml, .yaml, .yml, .toml, .ini, .cfg, .conf, .md). - matches: defaults to case-insensitive, and accepts an `options?` arg. - caseSensitive default: true for contains/notContains/notContainsInSource, false for matches. - Update stale example model claude-sonnet-4-6 -> claude-sonnet-5.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated ChangesEval authoring documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Corrects five claims in
docs/ADDING_EVALS.mdthat had drifted from the framework code:setup_command— it does support&&-chained sub-commands (run in sequence byrunSetupCommand, relied on by theflask/fastapievals). The doc wrongly said "no operators, one command only."notContainsInSource— lists the full set of non-source extensions it actually skips (.env*,.json,.plist,.xml,.yaml,.yml,.toml,.ini,.cfg,.conf,.md) pertext-search-utils.ts, instead of just three.matches— defaults to case-insensitive (perprimitives.ts), and its signature accepts anoptions?arg; both were misdocumented.caseSensitivedefault — clarified:trueforcontains/notContains/notContainsInSource,falseformatches.claude-sonnet-4-6→claude-sonnet-5(matcheseval.config.jsmodels.known).Test plan
Docs-only change. Verified each claim against the source:
packages/evals-core/src/workspace/workspace.ts(runSetupCommand)packages/evals-core/src/graders/executors/text-search-utils.tspackages/evals-graders/src/primitives.tsapps/auth0-evals/eval.config.jsSummary by CodeRabbit
setup_commandbehavior using&&.