Skip to content

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented Jan 30, 2021

This adds a few links to the cell module docs to make it a little easier to navigate to the types and functions it references.

@rust-highfive
Copy link
Contributor

r? @joshtriplett

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 30, 2021
Comment on lines +187 to +191
//! [`Arc<T>`]: ../../std/sync/struct.Arc.html
//! [`Rc<T>`]: ../../std/rc/struct.Rc.html
//! [`RwLock<T>`]: ../../std/sync/struct.RwLock.html
//! [`Mutex<T>`]: ../../std/sync/struct.Mutex.html
//! [`atomic`]: ../../core/sync/atomic/index.html
Copy link
Contributor

@jfrimmel jfrimmel Jan 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
//! [`Arc<T>`]: ../../std/sync/struct.Arc.html
//! [`Rc<T>`]: ../../std/rc/struct.Rc.html
//! [`RwLock<T>`]: ../../std/sync/struct.RwLock.html
//! [`Mutex<T>`]: ../../std/sync/struct.Mutex.html
//! [`atomic`]: ../../core/sync/atomic/index.html
//! [`Arc<T>`]: crate::sync::Arc
//! [`Rc<T>`]: crate::rc::Rc
//! [`RwLock<T>`]: crate::sync::RwLock
//! [`Mutex<T>`]: crate::sync::Mutex
//! [`atomic`]: crate::sync::atomic

I think its time for using intra-doc-links should be used.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that is possible. These docs live in core, but most of those only exist in std or alloc. I do not believe intra-doc-links support that.

@rust-log-analyzer
Copy link
Collaborator

The job mingw-check failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)
configure: rust.channel         := nightly
configure: rust.debug-assertions := True
configure: llvm.assertions      := True
configure: dist.missing-tools   := True
configure: build.configure-args := ['--enable-sccache', '--disable-manage-submodu ...
configure: writing `config.toml` in current directory
configure: 
configure: run `python /checkout/x.py --help`
configure: 
---
skip untracked path cpu-usage.csv during rustfmt invocations
skip untracked path src/doc/book/ during rustfmt invocations
skip untracked path src/doc/rust-by-example/ during rustfmt invocations
skip untracked path src/llvm-project/ during rustfmt invocations
Diff in /checkout/library/core/src/cell.rs at line 190:
 //! [`Mutex<T>`]: ../../std/sync/struct.Mutex.html
 //! [`atomic`]: ../../core/sync/atomic/index.html
-
-
 #![stable(feature = "rust1", since = "1.0.0")]
 use crate::cmp::Ordering;
 use crate::cmp::Ordering;
Running `"/checkout/obj/build/x86_64-unknown-linux-gnu/stage0/bin/rustfmt" "--config-path" "/checkout" "--edition" "2018" "--unstable-features" "--skip-children" "--check" "/checkout/library/core/src/cell.rs"` failed.
If you're running `tidy`, try again with `--bless`. Or, if you just want to format code, run `./x.py fmt` instead.
Build completed unsuccessfully in 0:00:22

@jackh726
Copy link
Member

jackh726 commented Feb 3, 2021

@bors r+ rollup

r? @jackh726

@bors
Copy link
Collaborator

bors commented Feb 3, 2021

📌 Commit 4749ad0 has been approved by jackh726

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 3, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 3, 2021
…laumeGomez

Rollup of 4 pull requests

Successful merges:

 - rust-lang#81144 (Fixed formatting typo in map_while docs)
 - rust-lang#81573 (Add some links to the cell docs.)
 - rust-lang#81679 (Bind all clean::Type variants and remove FIXME)
 - rust-lang#81681 (Better styling of "Switch result tab" shortcut)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit b750162 into rust-lang:master Feb 3, 2021
@rustbot rustbot added this to the 1.51.0 milestone Feb 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants