Merge #639 #640

639: Add list of main items to docs of utils and atomic modules r=taiki-e a=taiki-e Both [`sync`](https://docs.rs/crossbeam/0.8.0/crossbeam/sync/index.html) and [`queue`](https://docs.rs/crossbeam/0.8.0/crossbeam/queue/index.html) modules have similar docs. 640: Remove needless doc link r=taiki-e a=taiki-e Co-authored-by: Taiki Endo <[email protected]>
crossbeam-rs · Jan 4, 2021 · a95c02e · a95c02e
3 parents bbe1b5e + 7b5a884 + 9f3039c
commit a95c02e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/crossbeam-utils/src/atomic/mod.rs b/crossbeam-utils/src/atomic/mod.rs
@@ -1,4 +1,7 @@
 //! Atomic types.
+//!
+//! * [`AtomicCell`], a thread-safe mutable memory location.
+//! * [`AtomicConsume`], for reading from primitive atomic types with "consume" ordering.
 
 #[cfg(not(loom_crossbeam))]
 use cfg_if::cfg_if;

diff --git a/crossbeam-utils/src/thread.rs b/crossbeam-utils/src/thread.rs
@@ -110,8 +110,6 @@
 //!     });
 //! }).unwrap();
 //! ```
-//!
-//! [`std::thread::spawn`]: std::thread::spawn
 
 use std::fmt;
 use std::io;

diff --git a/src/lib.rs b/src/lib.rs
@@ -59,8 +59,12 @@
 #[cfg_attr(feature = "nightly", cfg(target_has_atomic = "ptr"))]
 pub use crossbeam_utils::atomic;
 
-/// Miscellaneous utilities.
 pub mod utils {
+    //! Miscellaneous utilities.
+    //!
+    //! * [`Backoff`], for exponential backoff in spin loops.
+    //! * [`CachePadded`], for padding and aligning a value to the length of a cache line.
+
     pub use crossbeam_utils::Backoff;
     pub use crossbeam_utils::CachePadded;
 }