Fix docs for HashSet::insert #29851
Fix docs for HashSet::insert #29851
Conversation
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.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
|
@bors: r+ thanks so much! 💯 |
|
📌 Commit 2569747 has been approved by |
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
| /// 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. |
There was a problem hiding this comment.
It removes the guarantee, that the key is not updated, added in #27894.
"If the set did have this key present, the key is not updated and false is returned." would be more correct.
Also, BTreeSet has identical docs, they should probably be updated too.
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