From 867cd81c3ce1548133a4ef9c27299a253b8a0e88 Mon Sep 17 00:00:00 2001 From: Samu Kumpulainen Date: Sun, 28 Apr 2024 15:06:12 +0300 Subject: Add doc comment to set.drop --- src/gleam/set.gleam | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'src') 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) } -- cgit v1.2.3