Merge #559 #560

559: Use intra-doc links r=stjepang a=taiki-e

Switch to use [intra-doc links](rust-lang/rfcs#1946) in all crates. Previously there was a big bug on cross crate re-exports (rust-lang/rust#65983), but it has been fixed, so we can use this in crossbeam.

This also adds checks of the docs to CI.

560: Use collect::<Box<[_]>>() directly in ShardedLock::new() r=stjepang a=taiki-e



Co-authored-by: Taiki Endo <[email protected]>

Author: bors[bot]

ci/crossbeam-channel.sh

@@ -11,4 +11,6 @@ cargo test -- --test-threads=1
 if [[ "$RUST_VERSION" == "nightly"* ]]; then
     cd benchmarks
     cargo check --bins
+
+    RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps --all-features
 fi

ci/crossbeam-deque.sh

@@ -7,3 +7,7 @@ export RUSTFLAGS="-D warnings"
 
 cargo check --bins --examples --tests
 cargo test
+
+if [[ "$RUST_VERSION" == "nightly"* ]]; then
+    RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps --all-features
+fi

ci/crossbeam-epoch.sh

@@ -11,6 +11,8 @@ cargo test
 if [[ "$RUST_VERSION" == "nightly"* ]]; then
     cargo test --features nightly
 
+    RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps --all-features
+
     if [[ "$OSTYPE" == "linux"* ]]; then
         ASAN_OPTIONS="detect_odr_violation=0 detect_leaks=0" \
         RUSTFLAGS="-Z sanitizer=address" \

ci/crossbeam-queue.sh

@@ -7,3 +7,7 @@ export RUSTFLAGS="-D warnings"
 
 cargo check --bins --examples --tests
 cargo test
+
+if [[ "$RUST_VERSION" == "nightly"* ]]; then
+    RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps --all-features
+fi

ci/crossbeam-skiplist.sh

@@ -10,4 +10,6 @@ cargo test
 
 if [[ "$RUST_VERSION" == "nightly"* ]]; then
     cargo test --features nightly
+
+    RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps --all-features
 fi

ci/crossbeam-utils.sh

@@ -10,4 +10,6 @@ cargo test
 
 if [[ "$RUST_VERSION" == "nightly"* ]]; then
     cargo test --features nightly
+
+    RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps --all-features
 fi

ci/crossbeam.sh

@@ -10,4 +10,6 @@ cargo test
 
 if [[ "$RUST_VERSION" == "nightly"* ]]; then
     cargo test --features nightly
+
+    RUSTDOCFLAGS=-Dwarnings cargo doc --no-deps --all-features
 fi

crossbeam-channel/src/channel.rs

@@ -911,8 +911,7 @@ impl<T> Receiver<T> {
     /// Each call to [`next`] blocks waiting for the next message and then returns it. However, if
     /// the channel becomes empty and disconnected, it returns [`None`] without blocking.
     ///
-    /// [`next`]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next
-    /// [`None`]: https://doc.rust-lang.org/std/option/enum.Option.html#variant.None
+    /// [`next`]: Iterator::next
     ///
     /// # Examples
     ///
@@ -944,7 +943,7 @@ impl<T> Receiver<T> {
     /// Each call to [`next`] returns a message if there is one ready to be received. The iterator
     /// never blocks waiting for the next message.
     ///
-    /// [`next`]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next
+    /// [`next`]: Iterator::next
     ///
     /// # Examples
     ///
@@ -1062,8 +1061,7 @@ impl<T> IntoIterator for Receiver<T> {
 /// Each call to [`next`] blocks waiting for the next message and then returns it. However, if the
 /// channel becomes empty and disconnected, it returns [`None`] without blocking.
 ///
-/// [`next`]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next
-/// [`None`]: https://doc.rust-lang.org/std/option/enum.Option.html#variant.None
+/// [`next`]: Iterator::next
 ///
 /// # Examples
 ///
@@ -1111,7 +1109,7 @@ impl<T> fmt::Debug for Iter<'_, T> {
 /// Each call to [`next`] returns a message if there is one ready to be received. The iterator
 /// never blocks waiting for the next message.
 ///
-/// [`next`]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next
+/// [`next`]: Iterator::next
 ///
 /// # Examples
 ///
@@ -1161,8 +1159,7 @@ impl<T> fmt::Debug for TryIter<'_, T> {
 /// Each call to [`next`] blocks waiting for the next message and then returns it. However, if the
 /// channel becomes empty and disconnected, it returns [`None`] without blocking.
 ///
-/// [`next`]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next
-/// [`None`]: https://doc.rust-lang.org/std/option/enum.Option.html#variant.None
+/// [`next`]: Iterator::next
 ///
 /// # Examples
 ///

crossbeam-channel/src/err.rs

@@ -7,15 +7,15 @@ use std::fmt;
 ///
 /// The error contains the message so it can be recovered.
 ///
-/// [`send`]: struct.Sender.html#method.send
+/// [`send`]: super::Sender::send
 #[derive(PartialEq, Eq, Clone, Copy)]
 pub struct SendError<T>(pub T);
 
 /// An error returned from the [`try_send`] method.
 ///
 /// The error contains the message being sent so it can be recovered.
 ///
-/// [`try_send`]: struct.Sender.html#method.try_send
+/// [`try_send`]: super::Sender::try_send
 #[derive(PartialEq, Eq, Clone, Copy)]
 pub enum TrySendError<T> {
     /// The message could not be sent because the channel is full.
@@ -32,7 +32,7 @@ pub enum TrySendError<T> {
 ///
 /// The error contains the message being sent so it can be recovered.
 ///
-/// [`send_timeout`]: struct.Sender.html#method.send_timeout
+/// [`send_timeout`]: super::Sender::send_timeout
 #[derive(PartialEq, Eq, Clone, Copy)]
 pub enum SendTimeoutError<T> {
     /// The message could not be sent because the channel is full and the operation timed out.
@@ -49,13 +49,13 @@ pub enum SendTimeoutError<T> {
 ///
 /// A message could not be received because the channel is empty and disconnected.
 ///
-/// [`recv`]: struct.Receiver.html#method.recv
+/// [`recv`]: super::Receiver::recv
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 pub struct RecvError;
 
 /// An error returned from the [`try_recv`] method.
 ///
-/// [`try_recv`]: struct.Receiver.html#method.recv
+/// [`try_recv`]: super::Receiver::try_recv
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 pub enum TryRecvError {
     /// A message could not be received because the channel is empty.
@@ -70,7 +70,7 @@ pub enum TryRecvError {
 
 /// An error returned from the [`recv_timeout`] method.
 ///
-/// [`recv_timeout`]: struct.Receiver.html#method.recv_timeout
+/// [`recv_timeout`]: super::Receiver::recv_timeout
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 pub enum RecvTimeoutError {
     /// A message could not be received because the channel is empty and the operation timed out.
@@ -87,31 +87,31 @@ pub enum RecvTimeoutError {
 ///
 /// Failed because none of the channel operations were ready.
 ///
-/// [`try_select`]: struct.Select.html#method.try_select
+/// [`try_select`]: super::Select::try_select
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 pub struct TrySelectError;
 
 /// An error returned from the [`select_timeout`] method.
 ///
 /// Failed because none of the channel operations became ready before the timeout.
 ///
-/// [`select_timeout`]: struct.Select.html#method.select_timeout
+/// [`select_timeout`]: super::Select::select_timeout
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 pub struct SelectTimeoutError;
 
 /// An error returned from the [`try_ready`] method.
 ///
 /// Failed because none of the channel operations were ready.
 ///
-/// [`try_ready`]: struct.Select.html#method.try_ready
+/// [`try_ready`]: super::Select::try_ready
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 pub struct TryReadyError;
 
 /// An error returned from the [`ready_timeout`] method.
 ///
 /// Failed because none of the channel operations became ready before the timeout.
 ///
-/// [`ready_timeout`]: struct.Select.html#method.ready_timeout
+/// [`ready_timeout`]: super::Select::ready_timeout
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 pub struct ReadyTimeoutError;
 

crossbeam-channel/src/lib.rs

@@ -316,20 +316,10 @@
 //! }
 //! ```
 //!
-//! [`std::sync::mpsc`]: https://doc.rust-lang.org/std/sync/mpsc/index.html
-//! [`unbounded`]: fn.unbounded.html
-//! [`bounded`]: fn.bounded.html
-//! [`after`]: fn.after.html
-//! [`tick`]: fn.tick.html
-//! [`never`]: fn.never.html
-//! [`send`]: struct.Sender.html#method.send
-//! [`recv`]: struct.Receiver.html#method.recv
-//! [`iter`]: struct.Receiver.html#method.iter
-//! [`try_iter`]: struct.Receiver.html#method.try_iter
-//! [`select!`]: macro.select.html
-//! [`Select`]: struct.Select.html
-//! [`Sender`]: struct.Sender.html
-//! [`Receiver`]: struct.Receiver.html
+//! [`send`]: Sender::send
+//! [`recv`]: Receiver::recv
+//! [`iter`]: Receiver::iter
+//! [`try_iter`]: Receiver::try_iter
 
 #![doc(test(
     no_crate_inject,