-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
rustdoc: update pulldown + fix spurious rendering difference around footnotes #45421
Conversation
(rust_highfive has picked a reviewer for you, use r? to override) |
This does not fix the issue:
|
(We should still land this, as I believe it does fix rendering issues, or so I hear; I haven't validated that myself yet. But it doesn't fix the warning) |
I've just pushed an update that adds a check to bypass reporting a warning if the difference was with |
With my PR + this PR, we have no warnings 🎊 @bors: r+ |
📌 Commit cee1991 has been approved by |
The ids are generated by rustdoc so they could have been changed to match hoedown: rust/src/librustdoc/html/markdown.rs Line 374 in cc03782
|
@bors rollup |
@ollie27 D'oh! Since this is already in the middle of a rollup, i'll grab that in a separate PR. Nice catch! |
☔ The latest upstream changes (presumably #45430) made this pull request unmergeable. Please resolve the merge conflicts. |
@QuietMisdreavus No it failed to make into the rollup 😄, so that change could be put in this PR. |
cee1991
to
af09ba8
Compare
@kennytm Oh, didn't notice that, oops. Take two! I just force-pushed a different update that uses @ollie27's suggestion rather than writing in a warning suppression. I ran it locally and it fixed the rendering differences in libcore the same as the other way, only this time it's because it's actually the same. |
@GuillaumeGomez @ollie27 Is this PR good to go? |
Seems good for me. |
Since the footnote mitigation changed after the initial approval, this is worth another look before i blindly re-r+ it. |
@bors: r+ |
📌 Commit af09ba8 has been approved by |
…steveklabnik rustdoc: update pulldown + fix spurious rendering difference around footnotes fixes rust-lang#45420
…steveklabnik rustdoc: update pulldown + fix spurious rendering difference around footnotes fixes rust-lang#45420
Is it really time? Have our months, no, *years* of suffering come to an end? Are we finally able to cast off the pall of Hoedown? The weight which has dragged us down for so long? ----- So, timeline for those who need to catch up: * Way back in December 2016, [we decided we wanted to switch out the markdown renderer](rust-lang#38400). However, this was put on hold because the build system at the time made it difficult to pull in dependencies from crates.io. * A few months later, in March 2017, [the first PR was done, to switch out the renderers entirely](rust-lang#40338). The PR itself was fraught with CI and build system issues, but eventually landed. * However, not all was well in the Rustdoc world. During the PR and shortly after, we noticed [some differences in the way the two parsers handled some things](rust-lang#40912), and some of these differences were major enough to break the docs for some crates. * A couple weeks afterward, [Hoedown was put back in](rust-lang#41290), at this point just to catch tests that Pulldown was "spuriously" running. This would at least provide some warning about spurious tests, rather than just breaking spontaneously. * However, the problems had created enough noise by this point that just a few days after that, [Hoedown was switched back to the default](rust-lang#41431) while we came up with a solution for properly warning about the differences. * That solution came a few weeks later, [as a series of warnings when the HTML emitted by the two parsers was semantically different](rust-lang#41991). But that came at a cost, as now rustdoc needed proc-macro support (the new crate needed some custom derives farther down its dependency tree), and the build system was not equipped to handle it at the time. It was worked on for three months as the issue stumped more and more people. * In that time, [bootstrap was completely reworked](rust-lang#43059) to change how it ordered compilation, and [the method by which it built rustdoc would change](rust-lang#43482), as well. This allowed it to only be built after stage1, when proc-macros would be available, allowing the "rendering differences" PR to finally land. * The warnings were not perfect, and revealed a few [spurious](rust-lang#44368) [differences](rust-lang#45421) between how we handled the renderers. * Once these were handled, [we flipped the switch to turn on the "rendering difference" warnings all the time](rust-lang#45324), in October 2017. This began the "warning cycle" for this change, and landed in stable in 1.23, on 2018-01-04. * Once those warnings hit stable, and after a couple weeks of seeing whether we would get any more reports than what we got from sitting on nightly/beta, [we switched the renderers](rust-lang#47398), making Pulldown the default but still offering the option to use Hoedown. And that brings us to the present. We haven't received more new issues from this in the meantime, and the "switch by default" is now on beta. Our reasoning is that, at this point, anyone who would have been affected by this has run into it already.
fixes #45420