Skip to content

Fix intra-doc links for non-path primitives #80181

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.

Sign up for GitHub

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

Merged
bors merged 4 commits into from
Dec 27, 2020
Merged

Fix intra-doc links for non-path primitives #80181

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0fd4f8f
Add a custom `Res` type
jyn514 Dec 19, 2020
4092891
Fix intra-doc links for non-path primitives
jyn514 Dec 19, 2020
8842c1c
Fix new ambiguity in the standard library
jyn514 Dec 19, 2020
6ac52f0
Don't process `[]` and `()` in intra-doc links
jyn514 Dec 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix new ambiguity in the standard library 
This caught several bugs where people expected `slice` to link to the
primitive, but it linked to the module instead.

This also uses `cfg_attr(bootstrap)` since the ambiguity only occurs
when compiling with stage 1.
  • Loading branch information
@jyn514
jyn514 committed Dec 22, 2020
commit 8842c1ccf33649f00e72a6f0be284919a847e69b
5 changes: 3 additions & 2 deletions library/std/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@
//! [`str`]: prim@str
//! [`mpsc`]: sync::mpsc
//! [`std::cmp`]: cmp
//! [`std::slice`]: slice
//! [`std::slice`]: mod@slice
//! [`use std::env`]: env/index.html
//! [`use`]: ../book/ch07-02-defining-modules-to-control-scope-and-privacy.html
//! [crates.io]: https://crates.io
Expand All @@ -185,7 +185,8 @@
//! [other]: #what-is-in-the-standard-library-documentation
//! [primitive types]: ../book/ch03-02-data-types.html
//! [rust-discord]: https://discord.gg/rust-lang

#![cfg_attr(not(bootstrap), doc = "[array]: prim@array")]
#![cfg_attr(not(bootstrap), doc = "[slice]: prim@slice")]
#![cfg_attr(not(feature = "restricted-std"), stable(feature = "rust1", since = "1.0.0"))]
#![cfg_attr(feature = "restricted-std", unstable(feature = "restricted_std", issue = "none"))]
#![doc(
Expand Down