Added package documentation.

pkg/cmp/doc.go

@@ -0,0 +1,5 @@
+// Package cmp provides a set of utility functions for comparing and sorting values in Go.
+// It includes functions for creating Comparers, which are functions that compare two values of the same type.
+//
+// The package is designed to be used with the Go standard library's sort package.
+package cmp

pkg/collection/doc.go

@@ -0,0 +1,2 @@
+// Package collection provides data structures and algorithms.
+package collection

pkg/collection/set/doc.go

@@ -0,0 +1,2 @@
+// Package set provides a map-based implementation of a set.
+package set

pkg/constraint/doc.go

@@ -0,0 +1,2 @@
+// Package constraint defines various type-constraining interfaces used throughout the library.
+package constraint

pkg/mapper/doc.go

@@ -0,0 +1,2 @@
+// Package mapper provides a set of functions for transforming values in Go.
+package mapper

pkg/optional/doc.go

@@ -0,0 +1,5 @@
+// Package optional defines types for working with optional values, inspired by Java's `Optional` class.
+// An optional value either contains a value of a certain type (Some), or it is empty (None).
+// This package provides a way to safely handle such values without the risk of null pointer dereferences.
+// It includes functions for creating optional values, checking if they are present, and retrieving the value if it is present.
+package optional

pkg/pair/doc.go

@@ -0,0 +1,2 @@
+// Package pair provides a generic implementation of a pair of values.
+package pair

pkg/pointer/doc.go

@@ -0,0 +1,3 @@
+// Package pointer provides utilities for working with pointers.
+// It includes functions for creating pointers, checking if they are nil, and retrieving the value if it is not nil.
+package pointer

pkg/pred/doc.go

@@ -0,0 +1,2 @@
+// Package pred provides various generic predicate functions.
+package pred

pkg/stream/doc.go

@@ -0,0 +1,4 @@
+// Package stream provides an abstraction for working with a stream of values supporting sequential computational operations.
+// Streams are lazy; computation on the source data is only performed when the terminal operation is initiated, and source elements are consumed only as needed.
+// It is inspired by Java's `Stream` class.
+package stream