From 4af86fd16d6e49555bababc4036c175fd766e23f Mon Sep 17 00:00:00 2001 From: Joel Aschmann Date: Thu, 11 Jan 2024 20:48:05 +0100 Subject: [PATCH] Fix old doc reference --- src/prng.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/prng.rs b/src/prng.rs index 6194618d..3e9d3026 100644 --- a/src/prng.rs +++ b/src/prng.rs @@ -2,9 +2,9 @@ //! by seeding them with data obtained from the [`crate::hwrng`] module. //! //! At the moment two prngs are available: [`rand::rngs::StdRng`] and [`crate::random::Random`]. -//! Both of these claim to be cryptographic secure prngs. Provided of course the seeds from `hwrng` -//! are secure to begin with, which drastically depends on the board used, see remarks in [`crate::hwrng`] module! - +//! Both of these claim to be cryptographic secure prngs. Provided the seeds from RIOTs HWRNG that are used +//! provide enough entropy to begin with, which drastically depends on the board used, +//! see remarks in [RIOTs documentation](https://doc.riot-os.org/group__drivers__periph__hwrng.html). use embedded_hal::prelude::_embedded_hal_blocking_rng_Read; use rand::{rngs::StdRng, SeedableRng}; @@ -14,7 +14,7 @@ use crate::{ random::{Random, RandomSeed}, }; -/// Seeds a [`crate::random::Random`] prng with a 32bit seed generated by [`crate::hwrng::HWRNG`]. +/// Seeds a [`crate::random::Random`] prng with a 32 byte seed generated by RIOTs HWRNG. /// /// See this modules description regarding quality of the used seeds. /// @@ -27,7 +27,7 @@ pub fn riot_prng() -> Random<32> { Random::<32>::from_seed(RandomSeed::new_from_hwrng()) } -/// Seeds a [`rand::rngs::StdRng`] prng with a 32bit seed generated by [`crate::hwrng::HWRNG`]. +/// Seeds a [`rand::rngs::StdRng`] prng with a 32 byte seed generated by RIOTs HWRNG. /// /// See this modules description regarding quality of the used seeds. pub fn rand_prng() -> StdRng {