chore: remove description in favor of markdownDescription
#3068
Conversation
This file contains 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
GavinZZ
approved these changes
Mar 27, 2023
acristin
approved these changes
Mar 27, 2023
ssenchenko
approved these changes
Mar 27, 2023
xazhao
approved these changes
Mar 27, 2023
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.
Issue #, if available
Description of changes
Some schema cleanup; gets rid of
descriptionfrom SAM properties, in favor of onlymarkdownDescription.descriptionalso isn't explicitly Markdown, so using it there can produce weird results.The CloudFormation documentation so far doesn't include
descriptioneither, so now it's consistent everywhere.Description of how you validated changes
Checked it still works as expected in VS Code.
Checklist
Examples?
Please reach out in the comments if you want to add an example. Examples will be
added to
sam initthrough aws/aws-sam-cli-app-templates.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.