docs(bench): document the reset-onboarding bench command + enforce sync - #1140
Open
Navin-S-R wants to merge 1 commit into
Open
docs(bench): document the reset-onboarding bench command + enforce sync#1140Navin-S-R wants to merge 1 commit into
Navin-S-R wants to merge 1 commit into
Conversation
…orce the doc stays in sync Adds docs/bench-commands.md (reset-onboarding) and a test that fails CI if any command in commands/__init__.py's `commands` list isn't documented — so a newly-added bench command can't ship undocumented. (Doc lives at the repo root docs/ since the module's jarvis/docs/ is gitignored.)
Navin-S-R
added
backport-version-15
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
1 participant
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.
Adds
docs/bench-commands.mddocumenting the app's custom bench command (reset-onboarding) and a test (jarvis/tests/test_bench_commands_documented) that fails CI if any command registered incommands/__init__.pyisn't documented — so a newly-introduced bench command can't ship undocumented.Doc lives at the repo root
docs/since the module'sjarvis/docs/is gitignored. Mutation-verified: dropping a command from the doc fails the test.