TEST/FIX/DOC: Adding tests to ensure docs include scorers, scenarios, and attacks#2140
Merged
Merged
Conversation
… and attacks Adds doc-coverage guard tests (mirroring the existing converter test) so that new scorers, scenarios, and attacks must be documented: - scorers -> doc/code/scoring - scenarios -> doc/scanner/<package> (adaptive -> doc/code/scenarios) - attacks -> doc/code/executor Closes the current gaps the new tests surfaced (6 media/local scorers and the garak Doctor scenario) and re-executes the affected notebooks to refresh outputs. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
PR microsoft#2111 removed the pyrit/identifiers package but left its API page entry in doc/myst.yml, so gen_api_md no longer emits pyrit_identifiers.md and validate_docs fails on the missing TOC reference. Drop the stale entry. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
romanlutz
approved these changes
Jul 9, 2026
…e-tests # Conflicts: # doc/scanner/garak.ipynb
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
2 participants
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
Adds doc-coverage guard tests (mirroring the existing
test_converter_documentation.py) so newly added components must be documented, and closes the gaps the tests surfaced.Each test enumerates components the same way the app does and fails when one is missing from the docs:
ScorerRegistry) → must appear underdoc/code/scoring/ScenarioRegistry) → must appear indoc/scanner/<package>(adaptive →doc/code/scenarios/)AttackStrategyexports, alias-aware) → must appear underdoc/code/executor/Doc gaps closed
AudioTrueFalseScorer,VideoTrueFalseScorer,DecodingScorer,StaticPromptInjectionScorer,AudioFloatScaleScorer,VideoFloatScaleScorerDoctorscenarioAffected notebooks were re-executed so outputs are refreshed and
.py/.ipynbstay in sync.Tests
tests/unit/docs— 3 passed.