-
Notifications
You must be signed in to change notification settings - Fork 469
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
prost-build: do not escape brackets followed by parenthesis in comments #851
prost-build: do not escape brackets followed by parenthesis in comments #851
Conversation
…bracket in comments
e3aafa8
to
621f4ed
Compare
I'm seeing some weird behaviors on the |
Some lines are escaped both by Note that it's already the case, for example here where the regex only matched the outer brackets. It seems like the I'll update the regex to avoid double escaping, since anyway if the user escapes the brackets then we don't want to do it again. |
The diff of
|
51db66c
to
0c49d54
Compare
Hoping to bump this thread. Would be nice to have intra-doc linking in rustdocs. |
@pgimalac if you want to get the conflicts resolved we can get this merged. |
@LucioFranco I fixed the conflicts but there is a build error (unrelated to this PR) in the CI |
A proposal to fix #850.
Allows linking to items in doc comments by not escaping brackets followed by parenthesis.
// Some comment with a [Link]
->/// Some comment with a \[Link\]
// Some comment with a [Link](Link)
->/// Some comment with a \[Link\](Link)
// Some comment with a [Link]
->/// Some comment with a \[Link\]
// Some comment with a [Link](Link)
->/// Some comment with a [Link](Link)
EDIT: I also implemented the case with brackets following brackets
[Link][Link]
since it appears in some of the tests.EDIT: I also implemented not escaping brackets which are already escaped, it happens when using the
cleanup-markdown
feature, or if the user manually escapes brackets.