Fix multiple doc comment parse issues #2390
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
This commit fixes several issues where documentation comments were not emitting events individually, an issue where a valid documentation comment was being declared invalid, and an invalid documentation comment was being prepended to a valid documtation comment on the next member.
kstich
commented
Aug 29, 2024
Comment on lines
+4
to
+5
| [WARNING] -: Found documentation comments ('///') attached to nothing. Documentation comments must appear on their own lines, directly before shapes and members, and before any traits. The invalid comments were: Invalid 4 (inside trait)\nInvalid 5 (not before traits) | Model.BadDocumentationComment | ||
| [WARNING] -: Found documentation comments ('///') attached to nothing. Documentation comments must appear on their own lines, directly before shapes and members, and before any traits. The invalid comments were: Invalid 6 (not before traits)\nInvalid 7 (inside shape line) | Model.BadDocumentationComment |
There was a problem hiding this comment.
These two events still have combined invalid doc comments, but we're also in a better state than before.
JordonPhillips
approved these changes
Aug 30, 2024
hpmellema
approved these changes
Aug 30, 2024
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.
This commit fixes several issues where documentation comments were not emitting events individually, an issue where a valid documentation comment was being declared invalid, and an invalid documentation comment was being prepended to a valid documtation comment on the next member.
Resolves #2388
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.