Repository navigation
fix(PSD-10215): clarify min-severity help text - #26
Merged
Merged
Conversation
-S/--min-severity on workloads risky is a filter, not a sort option. Say so in the flag usage and command description, and point to --sort/--order. Fix two skill docs: the range said "0–4" but the code rejects 0, and "above severity 2" should read "at severity 2 or higher".
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues were identified in the CLI help and documentation clarification changes.
No open issues 🎉
What changed in this PR
Clarifies workloads risky --min-severity help in pscli without changing filtering or sorting behavior.
Changes:
- Explains that
-Sfilters severity inclusively, requires at least 1, and does not control sorting. - Corrects the severity range and threshold wording in skill documentation.
- Adds a rendered-help test for the sorting clarification.
| File | Description |
|---|---|
internal/skill/perfectscale/SKILL.md |
Clarifies that the example includes severity 2. |
internal/skill/perfectscale/references/cli-reference.md |
Corrects the minimum severity and distinguishes filtering from sorting. |
internal/cli/workloads.go |
Clarifies the command description and flag help. |
internal/cli/app_test.go |
Tests the rendered minimum-severity help text. |
Review effort: Balanced
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.
What?
workloads risky -S/--min-severityhelp now says it is a filter (severity >= N, min 1) and does not affect sort order; points to--sort/--order.riskycommand description.Why?
A customer read
-S 2as a sort option. Code is correct; the help text was ambiguous.Tested on dev?
No. Help text and docs only.
go build,go test, andgolangci-lintpass; new test covers the rendered help.