Fix rustdoc warnings #9468
Fix rustdoc warnings #9468
Conversation
Link `CliUnstable::add` just to `CliUnstable` instead. Signed-off-by: Paul Mabileau <paulmabileau@hotmail.fr>
Inline the link targets directly in the text. Signed-off-by: Paul Mabileau <paulmabileau@hotmail.fr>
Specify `Self::finish_download` instead of just `finish_download` and link to `crate::core::package::Downloads` instead of `Download` as `Downloads` is the public one, does the actual stuff and `Download` only stores data. Signed-off-by: Paul Mabileau <paulmabileau@hotmail.fr>
Add parentheses to disambiguate from `write!`. Signed-off-by: Paul Mabileau <paulmabileau@hotmail.fr>
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Eh2406 (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
r? @ehuss |
|
Thanks! Removing the private links is a little unfortunate, but probably should be fine. @bors r+ |
|
📌 Commit 9ea1cbd has been approved by |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
Update cargo 8 commits in e51522ab3db23b0d8f1de54eb1f0113924896331..070e459c2d8b79c5b2ac5218064e7603329c92ae 2021-05-07 21:29:52 +0000 to 2021-05-11 18:12:23 +0000 - Fix rustdoc warnings (rust-lang/cargo#9468) - Improve performance of git status check in `cargo package`. (rust-lang/cargo#9478) - Link to the new rustc tests chapter. (rust-lang/cargo#9477) - Bump index cache version to deal with semver metadata version mismatch. (rust-lang/cargo#9476) - Fix Url::into_string deprecation warning (rust-lang/cargo#9475) - Fix rust-lang/cargo#4482 and rust-lang/cargo#9449: set Fossil ignore and clean settings locally (rust-lang/cargo#9469) - Improve two error messages (rust-lang/cargo#9472) - Fix `cargo install` with a semver metadata version. (rust-lang/cargo#9467)
Change some small parts of the unit documentation in order to resolve warnings emitted when running
cargo docfrom the root of this project. It should help reduce the noise when checking that new or updated documentation builds correctly.See the commit messages for details about the modifications themselves, although they should be rather simple.
Cheers,
Paul.