Auto merge of #29851 - shahn:hashset_doc_fix, r=steveklabnik

insert() returns bool, but it was wrongly stated that if the set had the
key already present, that key would be returned (this was probably
copied from the HashMap docs). Also remove a reference to the
module-level documentation, which doesn't make sense as it doesn't give
any more context.

r? @steveklabnik
This commit is contained in:
bors 2015-11-16 09:22:51 +00:00
commit 94ec5f8f89

View File

@ -544,10 +544,7 @@ impl<T, S> HashSet<T, S>
///
/// If the set did not have a value present, `true` is returned.
///
/// If the set did have this key present, that value is returned, and the
/// entry is not updated. See the [module-level documentation] for more.
///
/// [module-level documentation]: index.html#insert-and-complex-keys
/// If the set did have this key present, `false` is returned.
///
/// # Examples
///