Fix first doc comment inside macro yield #15050
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
RX14
added
kind:bug
Sija
reviewed
Oct 1, 2024
| @@ -104,7 +104,7 @@ module Crystal | |||
| if (loc = @last.location) && loc.filename.is_a?(String) || is_yield | |||
| macro_expansion_pragmas = @macro_expansion_pragmas ||= {} of Int32 => Array(Lexer::LocPragma) | |||
| (macro_expansion_pragmas[@str.pos.to_i32] ||= [] of Lexer::LocPragma) << Lexer::LocPushPragma.new | |||
| @str << "begin " if is_yield | |||
| @str << "begin\n" if is_yield | |||
| @last.to_s(@str, macro_expansion_pragmas: macro_expansion_pragmas, emit_doc: true) | |||
| @str << " end" if is_yield | |||
There was a problem hiding this comment.
Perhaps this should be changed accordingly?
There was a problem hiding this comment.
I don't think there's a situation where this could cause harm.
|
I added a spec for this using the example from the OP. |
straight-shoota
approved these changes
Dec 16, 2024
ysbaddaden
approved these changes
Dec 16, 2024
Co-authored-by: Julien Portalier <[email protected]>
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.
The following example eats the doc comment:
This is because the first line of comment is generated on the same line as the
beginwhich is inserted when using{{yield}}, like so:Using a newline instead of whitespace after
beginin macro yield fixes this.