aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamu Kumpulainen <onesamu@gmail.com>2024-04-28 15:06:12 +0300
committerLouis Pilfold <louis@lpil.uk>2024-04-29 13:27:13 +0100
commit867cd81c3ce1548133a4ef9c27299a253b8a0e88 (patch)
treee7f3fc966eeb0400577790975888672bc927a8b4
parent00af688138ab8605e774c07d01032d3fc3a07954 (diff)
downloadgleam_stdlib-867cd81c3ce1548133a4ef9c27299a253b8a0e88.tar.gz
gleam_stdlib-867cd81c3ce1548133a4ef9c27299a253b8a0e88.zip
Add doc comment to set.drop
-rw-r--r--src/gleam/set.gleam9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/gleam/set.gleam b/src/gleam/set.gleam
index 735aee3..356da12 100644
--- a/src/gleam/set.gleam
+++ b/src/gleam/set.gleam
@@ -200,6 +200,15 @@ pub fn filter(
Set(dict.filter(in: set.dict, keeping: fn(m, _) { predicate(m) }))
}
+/// Creates a new set from a given set with all the same entries except any
+/// entry found on the given list.
+///
+/// ## Examples
+///
+/// ```gleam
+/// drop(from_list([1, 2, 3, 4]), [1, 3])
+/// // -> [2, 4]
+/// ```
pub fn drop(from set: Set(member), drop disallowed: List(member)) -> Set(member) {
list.fold(over: disallowed, from: set, with: delete)
}