Repository navigation
Conversation
This is a prereq for implementing LaTeX math. Because I want to be able to enable it on a per-docblock basis, re-exports need to be parsed with a different set of markdown parsing extensions than the items they link to, which means we can't just concatenate the strings and parse. In any case, markdown that does this would be hard to understand. We should probably lint on it anyway.
rustbot
added
S-waiting-on-author
This comment has been minimized.
This comment has been minimized.
rustbot
added
the
T-rustdoc-frontend
This comment has been minimized.
This comment has been minimized.
I want to catch false positives before running crater, but it seems like all of these really are re-exports.
d0bf5b3 to
c9f28f6
Compare
This comment has been minimized.
This comment has been minimized.
|
@bors try @craterbot run mode=rustdoc |
|
🚨 Error: missing start toolchain 🆘 If you have any trouble with Crater please ask in t-infra on Zulip |
This comment has been minimized.
This comment has been minimized.
…rt-concat, r=<try> rustdoc: detect docs that use re-export concat
|
@craterbot run mode=rustdoc |
|
👌 Experiment ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more |
craterbot
added
S-waiting-on-crater
|
🚧 Experiment ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more |
|
🎉 Experiment
Footnotes
|
craterbot
added
S-waiting-on-review
|
Okay, I checked about a dozen random-ish crates, and it seems like switching to separate parsing would be, at worse, neutral. For example, this line from plotters: Results in this: 
|
rustbot
removed
the
S-waiting-on-review
Change the way Rustdoc behaves when a re-export and its original item both have doc comments. In other words, code like this: ```rust /// original struct Foo; /// re-export pub use Foo as Bar; ``` In the current version of Rustdoc, the rendering is equivalent to: ```rust /// re-export /// original pub use Bar; ``` Because there's no blank line between the comments, you get "re-export original" as a single paragraph. The new version, introduced by this pull request, renders two paragraphs. It actually runs the Markdown parser separately for both items, so link refdefs, footnotes, and, in the future, syntax features are scoped separately. This change is a pre-requisite for [LaTeX support](rust-lang#162365), because it introduces the notion of syntax features into Rustdoc's Markdown. It lets you turn tex_math_dollars support on and off. As part of this change, a bug related to intra-doc links is also fixed. This shows up when the reexport and the item both have intra-doc links with the same visible path, but where they resolve to different items. The bug is demonstrated in `tests/rustdoc-html/reexport/link-with-same-name-but-different-destination.rs`. The other test case changes demonstrate that this is, technically, a breaking change. When I ran [a Crater test](rust-lang#162169) for docs that rely on this behavior, though, it seemed most authors weren't relying on it.
DO NOT MERGE WITHOUT SETTING THE DEFAULT BACK TO WARN
This is a prereq for implementing LaTeX math (tracking issue: #162365). Because I want to be able to enable it on a per-docblock basis, re-exports need to be parsed with a different set of markdown parsing extensions than the items they link to, which means we can't just concatenate the strings and parse like we do now.
This was pointed out, in a similar case, by rust-lang/rfcs#3958 (comment)
IMO, markdown that relies on rustdoc’s current behavior is hard to understand, because string concatenation on separate doc comments is stupid.
This lint is mostly added here to run a Crater, so that we can figure out if there are significant numbers of crates are relying on the current behavior.