Fix dangling doc comments in structures #1776
Merged
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
Due to differences in how structures are parsed vs lists and maps, dangling doc comments were not being handled properly on structure shapes. Our tests were only verifying the behavior for maps, so it wasn't caught initially. With these changes, proper warnings are emitted when there are dangling doc comments in a structure shape.
mtdowling
approved these changes
May 22, 2023
syall
pushed a commit
to Xtansia/smithy
that referenced
this pull request
Aug 11, 2023
Due to differences in how structures are parsed vs lists and maps, dangling doc comments were not being handled properly on structure shapes. Our tests were only verifying the behavior for maps, so it wasn't caught initially. With these changes, proper warnings are emitted when there are dangling doc comments in a structure shape.
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:
Due to differences in how structures are parsed vs lists and maps, dangling doc comments were not being handled properly on structure shapes. Our tests were only verifying the behavior for maps, so it wasn't caught initially. With these changes, proper warnings are emitted when there are dangling doc comments in a structure shape.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.