don't emit rustdoc::broken_intra_doc_links for stuff like [!NOTE] #144921
+23
−2
Conversation
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
|
r? @notriddle rustbot has assigned @notriddle. Use |
rustbot
added
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
lolbinarycat
force-pushed
the
rustdoc-intra-doc-gfm-141866
branch
from
42afec6 to
bfea0ee
Compare
fmease
reviewed
Aug 4, 2025
| if ignore_urllike && should_ignore_link(path_str) { | ||
| return None; | ||
| } | ||
| // ignore github flavored markdown special blockquotes, | ||
| // such as [!NOTE] and [!IMPORTANT] |
There was a problem hiding this comment.
Could you elaborate the comment slightly noting that it's ~common for people to include_str the README.md of their GitHub repo?
I think we want to highlight that cuz rustdoc doesn't use GitHub-flavored Markdown and doesn't support GitHub-style admonitions.
There was a problem hiding this comment.
yeah, good point, will elaborate.
There was a problem hiding this comment.
alright, I expanded the documentation and also made sure that [!] is still parsed as a link to the never type.
This comment has been minimized.
This comment has been minimized.
lolbinarycat
force-pushed
the
rustdoc-intra-doc-gfm-141866
branch
from
bfea0ee to
a09b688
Compare
lolbinarycat
force-pushed
the
rustdoc-intra-doc-gfm-141866
branch
from
a09b688 to
fa095a8
Compare
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.
fixes #141866