wip: some docs

Author: shoenig

collection.go

@@ -58,10 +58,6 @@ type Collection[T any] interface {
 	// ProperSubset returns whether the given Collection is a proper subset of the set.
 	ProperSubset(Collection[T]) bool
 
-	// TODO Superset(Collection[T])
-
-	// TODO ProperSuperset(Collection[T])
-
 	// Size returns the number of elements in the set.
 	Size() int
 

hashset.go

@@ -322,8 +322,9 @@ func (s *HashSet[T, H]) UnmarshalJSON(data []byte) error {
 	return unmarshalJSON[T](s, data)
 }
 
-// ForEach iterates the set calling visit for each element. If visit returns
-// false the iteration is halted.
+// ForEach iterates every element in s, apply the given visit function.
+//
+// If the visit returns false at any point, iteration is halted.
 func (s *HashSet[T, H]) ForEach(visit func(T) bool) {
 	for _, item := range s.items {
 		if !visit(item) {

set.go

@@ -292,6 +292,9 @@ func (s *Set[T]) UnmarshalJSON(data []byte) error {
 	return unmarshalJSON[T](s, data)
 }
 
+// ForEach iterates every element in s, applying the given visit function.
+//
+// If the visit returns false at any point, iteration is halted.
 func (s *Set[T]) ForEach(visit func(T) bool) {
 	for item := range s.items {
 		if !visit(item) {

treeset.go

@@ -520,6 +520,9 @@ func (s *TreeSet[T]) StringFunc(f func(element T) string) string {
 	return fmt.Sprintf("%s", l)
 }
 
+// ForEach iterates every element in s, applying the given visit function.
+//
+// If the visit function returns false at any point, iteration is halted.
 func (s *TreeSet[T]) ForEach(visit func(T) bool) {
 	s.infix(func(n *node[T]) (next bool) {
 		return visit(n.element)