Clarify Experimental detector behavior in documentation#1831
Open
pauld-msft wants to merge 1 commit into
Open
Conversation
Updated the behavior description for the Experimental stage to clarify that enabling experimental detectors will include output in scan results.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the “Detector Maturity Stages” documentation to clarify how Experimental detectors behave, specifically around when their detected components appear in scan results.
Changes:
- Expanded the Stage 2 (Experimental) behavior description to describe opt-in behavior for including results in scan output.
Show a summary per file
| File | Description |
|---|---|
| docs/creating-a-new-detector.md | Clarifies Experimental detector output behavior and how --DetectorArgs affects whether results appear in scan output. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
| |-------|-----------|----------| | ||
| | **1. Default Off** | `IDefaultOffComponentDetector` | Must be explicitly enabled via `--DetectorArgs YourDetectorId=EnableIfDefaultOff`. Detector should be fully functional and produce correct output. | | ||
| | **2. Experimental** | `IExperimentalDetector` | Runs automatically but output is NOT included in scan results. Used to measure performance impact. | | ||
| | **2. Experimental** | `IExperimentalDetector` | Runs automatically but output is NOT included in scan results. Used to measure performance impact. Enabling experimental detectors via `--DetectorArgs YourDetectorId=EnableIfDefaultOff` will cause output to be included in scan results. | |
grvillic
approved these changes
Jun 19, 2026
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.
Updated the behavior description for the Experimental stage to clarify that enabling experimental detectors will include output in scan results.