From e36c7da56c74368881b02a4bbf1f740714083c65 Mon Sep 17 00:00:00 2001 From: Dirk Gadsden Date: Sun, 6 Mar 2016 19:13:29 -0800 Subject: [PATCH] Clarify documentation of `hash::SipHasher` The docs were making assertions/recommendations they shouldn't have. This clarifies them and adds some helpful links. Fixes #32043. --- src/libcore/hash/sip.rs | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/src/libcore/hash/sip.rs b/src/libcore/hash/sip.rs index 722d77a8a11e..b1aab4c693de 100644 --- a/src/libcore/hash/sip.rs +++ b/src/libcore/hash/sip.rs @@ -19,15 +19,18 @@ use super::Hasher; /// /// See: http://131002.net/siphash/ /// -/// Consider this as a main "general-purpose" hash for all hashtables: it -/// runs at good speed (competitive with spooky and city) and permits -/// strong _keyed_ hashing. Key your hashtables from a strong RNG, -/// such as `rand::Rng`. +/// This is the default hashing function used by standard library (eg. +/// `collections::HashMap` uses it by default). +/// +/// SipHash is a general-purpose hashing function: it runs at a good +/// speed (competitive with Spooky and City) and permits strong _keyed_ +/// hashing. This lets you key your hashtables from a strong RNG, such +/// as [`rand::Rng`](https://doc.rust-lang.org/rand/rand/trait.Rng.html). /// /// Although the SipHash algorithm is considered to be cryptographically /// strong, this implementation has not been reviewed for such purposes. -/// As such, all cryptographic uses of this implementation are strongly -/// discouraged. +/// As such, all cryptographic uses of this implementation are _strongly +/// discouraged_. #[stable(feature = "rust1", since = "1.0.0")] pub struct SipHasher { k0: u64,