Fix some rustdoc warnings #46853
Merged
Fix some rustdoc warnings #46853
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
GuillaumeGomez
force-pushed
the
fix-rustdoc-warning
branch
from
330aca4 to
0f1f2d6
Compare
|
Waited long enough to make sure that there were no warnings when travis rendered the docs. @bors r+ rollup |
|
📌 Commit 0f1f2d6 has been approved by |
|
Travis failed. I suppose it's a dead link. @bors: r- |
kennytm
added
the
S-waiting-on-author
GuillaumeGomez
force-pushed
the
fix-rustdoc-warning
branch
from
0f1f2d6 to
8835289
Compare
|
Updated. |
|
r=me pending travis |
kennytm
added
S-waiting-on-review
|
@bors r=QuietMisdreavus |
|
📌 Commit 8835289 has been approved by |
kennytm
added
S-waiting-on-bors
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Dec 21, 2017
… r=QuietMisdreavus Fix some rustdoc warnings r? @QuietMisdreavus cc @steveklabnik
bors
added a commit
that referenced
this pull request
Dec 29, 2017
rustdoc: add option to abort the process on markdown differences In the efforts of keeping the std docs free of markdown warnings, this PR adds a stopgap measure to make sure the CI fails if it detects a markdown difference. It does this by adding a new unstable flag to rustdoc, `--deny-render-differences`, which bootstrap then passes to rustdoc when documenting std and friends. The implementation is... probably not the cleanest option. It currently adds an extra branch after it prints the markdown warnings, which just prints a final line and calls `::std::process::abort(1)`. I did it like this because if it just panics regularly, it looks like an ICE, an even though `html::render::run` returns a Result, that Result is also just `expect`ed immediately, generating the same problem. This way bypasses the panic handler at the top of the thread and looks like a proper failure. Since i don't have a real error Handler there, this is the best i can do without pulling in a real error system for rustdoc. This PR is blocked on #46853, which will fix the rendering differences that were present on master when i started this branch.
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.
r? @QuietMisdreavus
cc @steveklabnik