Allow symbols to be escaped in DocText #3375
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
rmhartog
requested review from
bterlson,
markcowl,
allenjzhang and
timotheeguerin
as code owners
|
@microsoft-github-policy-service agree |
rmhartog
force-pushed
the
bug/escape-characters-in-docblock
branch
from
bf80d93
to
2408c62
Compare
There was a problem hiding this comment.
@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
|
/azp run typespec - pr tools |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
All changed packages have been documented.
|
|
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
force-pushed
the
bug/escape-characters-in-docblock
branch
from
d5871e6
to
4306a71
Compare
rmhartog
force-pushed
the
bug/escape-characters-in-docblock
branch
from
4306a71
to
c1e853c
Compare
|
/azp run typespec - pr tools |
|
Azure Pipelines successfully started running 1 pipeline(s). |
rmhartog
force-pushed
the
bug/escape-characters-in-docblock
branch
from
7069530
to
0acc46c
Compare
|
/azp run typespec - pr tools |
|
Azure Pipelines successfully started running 1 pipeline(s). |
timotheeguerin
approved these changes
Jun 11, 2024
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
This was referenced Jul 5, 2024
This was referenced Jul 20, 2024
This was referenced Jul 28, 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.
Related to #3374, this is an implementation of escaping characters in doc comments, such as the
@symbol.