summary refs log tree commit diff
path: root/library/alloc/src
diff options
context:
space:
mode:
authorAriel Davis <ariel.z.davis@icloud.com>2022-05-31 22:08:14 -0700
committerAriel Davis <ariel.z.davis@icloud.com>2022-05-31 22:08:14 -0700
commitb02146a370e8e07186d4bd2c264699300ca925df (patch)
tree612f3b759a7cc96fd459d80125e128573f8bf53c /library/alloc/src
parent02916c4c75912f70b651c0b20b501444ce2ca231 (diff)
downloadrust-b02146a370e8e07186d4bd2c264699300ca925df.tar.gz
rust-b02146a370e8e07186d4bd2c264699300ca925df.zip
Tweak insert docs
Diffstat (limited to 'library/alloc/src')
-rw-r--r--library/alloc/src/collections/btree/set.rs10
1 files changed, 7 insertions, 3 deletions
diff --git a/library/alloc/src/collections/btree/set.rs b/library/alloc/src/collections/btree/set.rs
index 20ef834eaee..caa629cf4e6 100644
--- a/library/alloc/src/collections/btree/set.rs
+++ b/library/alloc/src/collections/btree/set.rs
@@ -770,10 +770,14 @@ impl<T> BTreeSet<T> {
 
     /// Adds a value to the set.
     ///
-    /// If the set did not have an equal element present, `true` is returned.
+    /// Returns whether the value was newly inserted. That is:
     ///
-    /// If the set did have an equal element present, `false` is returned, and
-    /// the entry is not updated. See the [module-level documentation] for more.
+    /// - If the set did not previously contain an equal value, `true` is
+    ///   returned.
+    /// - If the set already contained an equal value, `false` is returned, and
+    ///   the entry is not updated.
+    ///
+    /// See the [module-level documentation] for more.
     ///
     /// [module-level documentation]: index.html#insert-and-complex-keys
     ///