Fix docs comment for FILE_PATH

rust-random · May 3, 2024 · 6637a60 · 6637a60
1 parent efa18b8
commit 6637a60
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/src/use_file.rs b/src/use_file.rs
@@ -9,12 +9,12 @@ use core::{
     sync::atomic::{AtomicUsize, Ordering::Relaxed},
 };
 
-//! For all platforms, we use `/dev/urandom` rather than `/dev/random`.
-//! For more information see the linked man pages in lib.rs.
-//!   - On Linux, "/dev/urandom is preferred and sufficient in all use cases".
-//!   - On Redox, only /dev/urandom is provided.
-//!   - On AIX, /dev/urandom will "provide cryptographically secure output".
-//!   - On Haiku and QNX Neutrino they are identical.
+/// For all platforms, we use `/dev/urandom` rather than `/dev/random`.
+/// For more information see the linked man pages in lib.rs.
+///   - On Linux, "/dev/urandom is preferred and sufficient in all use cases".
+///   - On Redox, only /dev/urandom is provided.
+///   - On AIX, /dev/urandom will "provide cryptographically secure output".
+///   - On Haiku and QNX Neutrino they are identical.
 const FILE_PATH: &str = "/dev/urandom\0";
 const FD_UNINIT: usize = usize::max_value();