docs: describe step behavior instead of naming requirement IDs - #451
Merged
Conversation
Step doc comments had drifted into declaring which single requirement each step implements. That binding belongs in the dispatch map, which is already keyed by ID; a step that names one ID in its doc reads as though it may only ever serve that one, which is the opposite of the intent. Reword the 19 affected doc comments to describe the behavior being assessed. Five other references were cross-references to sibling steps rather than self-declarations. Those keep the pointer but name the function, which is what a reader can actually navigate to: classifyUntrustedCodeIsolation -> CicdUntrustedCodeIsolation CicdSanitizesCollaboratorInput -> CicdSanitizedInputParameters (x2) evaluateSastEnforcement -> SastEnforcedOnChanges testExecutionDocumentationEvidence -> TestExecutionDocumentation Comments only; every line in this diff begins with //. Refs ossf#448
github-actions
Bot
added
the
documentation
jmeridth
approved these changes
Aug 16, 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
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.
Step doc comments had drifted into declaring which single requirement each step implements. That binding belongs in the dispatch map, which is already keyed by ID; a step that names one ID in its doc reads as though it may only ever serve that one, which is the opposite of the intent.
Comments only; every line in this diff begins with //.
Part of #448