chore(awslint): disallow '@default undefined' annotations#4836
Merged
mergify[bot] merged 2 commits intomasterfrom Nov 6, 2019
Merged
chore(awslint): disallow '@default undefined' annotations#4836mergify[bot] merged 2 commits intomasterfrom
mergify[bot] merged 2 commits intomasterfrom
Conversation
We use the `@default` annotation to tell people about default values/behaviors if they leave out a particular property. Some contributors think we mean "literally describe what the value of the property is if it's not specified" and put in `@default undefined`, which is technically true but not very helpful. Add an awslint rule which disallows this.
Contributor
|
Thanks so much for taking the time to contribute to the AWS CDK ❤️ We will shortly assign someone to review this pull request and help get it
|
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
eladb
approved these changes
Nov 6, 2019
Contributor
|
Thank you for contributing! Your pull request is now being automatically merged. |
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
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
4 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.
We use the
@defaultannotation to tell people about defaultvalues/behaviors if they leave out a particular property.
Some contributors think we mean "literally describe what the value
of the property is if it's not specified" and put in
@default undefined, which is technically true but not very helpful.Add an awslint rule which disallows this.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license