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

Allow symbols to be escaped in DocText #3375

Merged

Conversation

rmhartog
Copy link
Contributor

Related to #3374, this is an implementation of escaping characters in doc comments, such as the @ symbol.

@rmhartog
Copy link
Contributor Author

@microsoft-github-policy-service agree

@rmhartog rmhartog force-pushed the bug/escape-characters-in-docblock branch from bf80d93 to 2408c62 Compare May 16, 2024 12:20
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.

@rmhartog thanks for the contribution, we'll discuss if that's something we want to add to the grammar of js doc. Seeing that it does that in TypeSCript I would assume it shouldn't be a problem. In the meantime if you want this to work you can also escape by wrapping the @ in backtick(markdown) playground

@timotheeguerin timotheeguerin added the compiler:core Issues for @typespec/compiler label May 16, 2024
@timotheeguerin
Copy link
Member

/azp run typespec - pr tools

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-sdk
Copy link
Collaborator

azure-sdk commented May 17, 2024

All changed packages have been documented.

  • @typespec/compiler
Show changes

@typespec/compiler - feature ✏️

Allow @ to be escaped in doc comment with \

@azure-sdk
Copy link
Collaborator

You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/3375/

Check the website changes at https://tspwebsitepr.z22.web.core.windows.net/prs/3375/

@rmhartog rmhartog force-pushed the bug/escape-characters-in-docblock branch from d5871e6 to 4306a71 Compare May 21, 2024 09:36
@rmhartog rmhartog force-pushed the bug/escape-characters-in-docblock branch from 4306a71 to c1e853c Compare May 22, 2024 07:50
@timotheeguerin
Copy link
Member

/azp run typespec - pr tools

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@microsoft microsoft deleted a comment from azure-pipelines bot May 23, 2024
@rmhartog rmhartog force-pushed the bug/escape-characters-in-docblock branch from 7069530 to 0acc46c Compare June 11, 2024 07:00
@timotheeguerin
Copy link
Member

/azp run typespec - pr tools

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

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.

Awesome!! thanks for the contribution and working with the review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler:core Issues for @typespec/compiler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants