feat: new Bicep linter rule use-parameter-descriptions#20036
Open
johnlokerse wants to merge 3 commits into
Open
feat: new Bicep linter rule use-parameter-descriptions#20036johnlokerse wants to merge 3 commits into
use-parameter-descriptions#20036johnlokerse wants to merge 3 commits into
Conversation
Contributor
Author
|
Documentation is needed for this |
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.
Description
This change adds a new Bicep linter rule called
use-parameter-descriptions. Default the rule level isoffbut when set toerrorit checks if the parameter has either the@sys.descriptionor@descriptiondecorator above a parameter. Additionally, it checks if the description is not empty.@anthony-c-martin @stephaniezyen This implements issue #9453 and #5595.
Example Usage
It works through the
bicep lintercommand or using the VSCode extension:Checklist
Microsoft Reviewers: Open in CodeFlow