Cleanup all doc warnings #806
Conversation
Susurrus
force-pushed
the
doc_warnings
branch
from
4fe5fd5
to
6f62886
Compare
|
What switch to Pulldown? Is this a new feature of rustc? |
|
rustdoc is switching from whatever it's using now to pulldown-cmark. This is good because it moves us to use CommonMark, which is standardized, than whatever the previous thing was doing. And it's a Rust-only lib. But there are some syntax changes. There's been warnings for this on nightly for a while and I believe Rust 1.22 includes these warnings as well. |
|
@asomers For reference here's the tracking bug: rust-lang/rust#38400 And as of 1.18, you can enable the new rendering with |
|
@asomers want to give this a review or are you fine with me merging it as-is? |
| @@ -1124,12 +1125,24 @@ pub fn getgroups() -> Result<Vec<Gid>> { | |||
| /// specific user and group. For example, given the user `www-data` with UID | |||
| /// `33` and the group `backup` with the GID `34`, one could switch the user as | |||
| /// follows: | |||
| /// ``` | |||
| /// | |||
| /// ```rust,no_run | |||
There was a problem hiding this comment.
Why are you adding no_run ? If this was an unreliable doc test, then you should fix it in a separate commit than the commit that fixes the doc warnings.
There was a problem hiding this comment.
It was never run before, that's the biggest part of this change. There were doctests that weren't being found and executed, so this doctest has never been run. And turns out it fails when run.
There was a problem hiding this comment.
I can put both of these changes in a separate commit that explains all this.
There was a problem hiding this comment.
Do you understand why they weren't being found? Because I don't.
There was a problem hiding this comment.
The previous parser didn't find them, so they weren't run. I was always curious why, but I never cared enough to actually read up on it. If you ran our tests right now with the latest Rust, it'd explain this in the compiler warnings, though not give too many specifics.
The switch to Pulldown for the Markdown parser for Rustdoc has revealed that there were a large number of doctests that weren't being run. These tests failed to compile before, but will also fail to run because they attach to arbitrary user and group IDs, which likely don't exist on the system. These are therefore marked as `no_run`.
With the impending switch to Pulldown as the default doc generator, warnings have been enabled for incompatible syntax. This fixes all of said warnings.
Susurrus
force-pushed
the
doc_warnings
branch
from
6f62886
to
133e350
Compare
|
Ok, perhaps a parser bug or something. Probably not worth investigating further. bors r+ |
With the impending switch to Pulldown as the default doc generator, warnings
have been enabled for incompatible syntax. This fixes all of said warnings.