about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2022-06-07 01:13:46 +0200
committerGitHub <noreply@github.com>2022-06-07 01:13:46 +0200
commitc4bfd106e19d3a6a67d45a9b13059bcc75792409 (patch)
tree661fd72d1037bdfe25424d4f6aea3e081755b566
parent50b00252aeb77b10db04d65dc9e12ce758def4b5 (diff)
parent7d114c7713537af3a1f67c15a67473e6f3f5a509 (diff)
downloadrust-c4bfd106e19d3a6a67d45a9b13059bcc75792409.tar.gz
rust-c4bfd106e19d3a6a67d45a9b13059bcc75792409.zip
Rollup merge of #97700 - nzrq:patch-1, r=dtolnay
Add note to documentation of HashSet::intersection

The functionality of the `std::collections::HashSet::intersection(...)` method was slightly surprising to me so I wanted to take a sec to contribute to the documentation for this method.

I've added a `Note:` section if that is appropriate.
-rw-r--r--library/std/src/collections/hash/set.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/library/std/src/collections/hash/set.rs b/library/std/src/collections/hash/set.rs
index 19428fe9a23..fa498a987d6 100644
--- a/library/std/src/collections/hash/set.rs
+++ b/library/std/src/collections/hash/set.rs
@@ -588,6 +588,12 @@ where
     /// Visits the values representing the intersection,
     /// i.e., the values that are both in `self` and `other`.
     ///
+    /// When an equal element is present in `self` and `other`
+    /// then the resulting `Intersection` may yield references to
+    /// one or the other. This can be relevant if `T` contains fields which
+    /// are not compared by its `Eq` implementation, and may hold different
+    /// value between the two equal copies of `T` in the two sets.
+    ///
     /// # Examples
     ///
     /// ```