diagnostics: improve E0758 note for backticks in doc comments#157092
Open
fabricnp wants to merge 1 commit into
Open
diagnostics: improve E0758 note for backticks in doc comments#157092fabricnp wants to merge 1 commit into
fabricnp wants to merge 1 commit into
Conversation
Collaborator
|
The parser was modified, potentially altering the grammar of (stable) Rust cc @fmease |
rustbot
added
S-waiting-on-review
Collaborator
|
r? @chenyukang rustbot has assigned @chenyukang. Use Why was this reviewer chosen?The reviewer was selected based on:
|
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
When a block doc-comment contains '/*' or '*/' inside a Markdown backtick span, the lexer's nesting depth becomes skewed. Because the lexer is intentionally blind to Markdown syntax, this behavior is working as designed. This commit adds a best-effort diagnostic heuristic to 'report_unterminated_block_comment'. It detects comment markers inside backtick spans and emits a note/help message pointing the user toward workarounds.
fabricnp
force-pushed
the
fix/improve-e0758-backtick-diagnostic
branch
from
ba7f76e to
e22494a
Compare
Contributor
|
@fabricnp please do not trigger unprompted reviews from bots in our repository, thanks. |
Author
Sorry, my apologies i am used to leaning on Copilot for automated linting in other ecosystems and didn't mean to introduce noise into the review thread here. this wont happen again. |
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
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.
When a block doc-comment contains
/*or*/inside a Markdown backtick span, the lexer's nesting depth becomes skewed. Because the lexer is intentionally blind to Markdown syntax, this behavior is working as designed.This commit adds a best-effort diagnostic heuristic to
report_unterminated_block_comment. It detects comment markers inside backtick spans and emits a note/help message pointing the user toward workarounds.Fixes #157034