Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixes bug rendering backslashes when present as last character in doc comment line #3881

Merged
merged 1 commit into from
Jul 18, 2024

Conversation

chrisradek
Copy link
Member

Fixes #3646

Updated scanDoc to only update the escaped flag when a backslash precedes @. This is the only character we currently unescape later on in this scenario currently.

@azure-sdk
Copy link
Collaborator

All changed packages have been documented.

  • @typespec/compiler
Show changes

@typespec/compiler - fix ✏️

Fixes a bug where ending a non-terminal line in a multi-line comment with a backslash caused the next star to show up in the parsed doc string.

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

Copy link
Member

@timotheeguerin timotheeguerin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice actually even simpler than before

@chrisradek chrisradek added this pull request to the merge queue Jul 18, 2024
Merged via the queue into microsoft:main with commit 61807aa Jul 18, 2024
22 checks passed
@chrisradek chrisradek deleted the fix-get-doc branch July 18, 2024 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: getDoc mishandled the description if it has a line of description ends with "\"
3 participants