Change:
/// } /// ``` /// <ins> /// ## `Hash` and `Eq` /// /// When implementing both `Hash` and [`Eq`], it is important that the following /// property holds: /// /// ```text /// k1 == k2 -> hash(k1) == hash(k2) /// ``` /// /// In other words, if two keys are equal, their hashes must also be equal. /// [`HashMap`] and [`HashSet`] both rely on this behavior. /// /// Thankfully, you won't need to worry about upholding this property when /// deriving both [`Eq`] and `Hash` with `#[derive(PartialEq, Eq, Hash)]`. /// </ins> /// [`Eq`]: ../../std/cmp/trait.Eq.html <ins> /// [`Hasher`]: trait.Hasher.html </ins> /// [`HashMap`]: ../../std/collections/struct.HashMap.html /// [`HashSet`]: ../../std/collections/struct.HashSet.html <del> /// [`.hash`]: #tymethod.hash </del> <ins> /// [`hash`]: #tymethod.hash </ins> #[stable(feature = "rust1", since = "1.0.0")] pub trait Hash { <del> /// Feeds this value into the state given, updating the hasher as necessary. </del> <ins> /// Feeds this value into the given [`Hasher`]. /// /// # Examples /// /// ``` /// use std::collections::hash_map::DefaultHasher; /// use std::hash::{Hash, Hasher}; /// /// let mut hasher = DefaultHasher::new(); /// 7920.hash(&mut hasher); /// println!("Hash is {:x}!", hasher.finish()); /// ``` /// /// [`Hasher`]: trait.Hasher.html </ins> #[stable(feature = "rust1", since = "1.0.0")] fn hash<H: Hasher>(&self, state: &mut H); <del> /// Feeds a slice of this type into the state provided. </del> <ins> /// Feeds a slice of this type into the given [`Hasher`]. /// /// # Examples /// /// ``` /// use std::collections::hash_map::DefaultHasher; /// use std::hash::{Hash, Hasher}; /// /// let mut hasher = DefaultHasher::new(); /// let numbers = [6, 28, 496, 8128]; /// Hash::hash_slice(&numbers, &mut hasher); /// println!("Hash is {:x}!", hasher.finish()); /// ``` /// /// [`Hasher`]: trait.Hasher.html </ins> #[stable(feature = "hash_slice", since = "1.3.0")] fn hash_slice<H: Hasher>(data: &[Self], state: &mut H) where Self: Sized

Discussion:
Part of Here's what needs to be done to close out this issue: needs a stronger summary/explanation distinction. "This structure is zero-sized and does not need construction." is weird. also needs a stronger summary/explanation distinction. It also needs a better explanation of why it exists with an example. needs general improvement, it is the main bit of this module, but its docs feel tossed together and have few examples or coherence. needs more than just a summary line; it needs explanation and examples.
What kind of further documentation are you looking for here?
Better explanations for examples of implementing and and and more docs generally for all three.
There seem to be a lengthy example of BuildHasherDefault in this commit () Also for BuildHasher and there is a healthy amount of documentation as of now. Hasher seems to be really outdated (still lists several Implementors without mentioning they have been deprecated), which I'm looking into right now.
Thanks ! Looks like all that's left is documenting .
I am happy to mentor anyone who wants to tackle this issue.
I volunteer as a tribute :-)
wonderful! If you need any help, please just let me know, as I said above, happy to help you help me (We can do it here or ping me on IRC)
I have more specifics in the main issue above
I'm gonna tackle this one this weekend! (if that's okay with you,