docs

gotidy · Nov 27, 2023 · 36c0c0f · 36c0c0f
1 parent f81dc05
commit 36c0c0f
Show file tree

Hide file tree

Showing 13 changed files with 15 additions and 2 deletions.
diff --git a/collections/README.md b/collections/README.md
@@ -7,6 +7,7 @@
 - [Map](maps/README.md) Contains map helpers.
 - [Slice](slice/README.md) Contains slice helpers.
 - [Set](set/README.md) Realize `Set` type.
+- [Group](group/README.md) Realize `Group` type.
 
 ## Documentation
 

diff --git a/collections/doc.go b/collections/doc.go
@@ -0,0 +1,2 @@
+// Package contains functions that simplify operations with maps, slices, sets, groups.
+package collections
diff --git a/collections/group/group.go b/collections/group/group.go
@@ -1,3 +1,4 @@
+// Realize `Group` type.
 package group
 
 // Group.

diff --git a/collections/maps/map.go b/collections/maps/map.go
@@ -1,3 +1,4 @@
+// Contains map helpers (Map, Filter, Reduce, Clone, Has, Diff and ect.).
 package maps
 
 import (

diff --git a/collections/set/set.go b/collections/set/set.go
@@ -1,3 +1,4 @@
+// Realize Set type.
 package set
 
 import (

diff --git a/collections/slice/slice.go b/collections/slice/slice.go
@@ -1,3 +1,4 @@
+// Contains slice helpers (Map, Filter, Reduce, Fold, Remove, ToMap and ect.).
 package slice
 
 import (

diff --git a/conditions/conditions.go b/conditions/conditions.go
@@ -1,3 +1,4 @@
+// Package contains functions that simplify inline conditions.
 package conditions
 
 // If returns the value depend to the condition.

diff --git a/conv/README.md b/conv/README.md
@@ -4,7 +4,7 @@
 
 [godev]: https://pkg.go.dev/github.com/gotidy/lib/conv
 
-Contains constraints types.
+Contains conversion helpers.
 
 ## Documentation
 

diff --git a/conv/conv.go b/conv/conv.go
@@ -1,3 +1,4 @@
+// Contains conversion helpers.
 package conv
 
 import (

diff --git a/math/limits.go b/math/limits.go
@@ -1,3 +1,4 @@
+// Contains mathematic functions.
 package math
 
 import "github.com/gotidy/lib/constraints"

diff --git a/oneof/oneof.go b/oneof/oneof.go
@@ -1,3 +1,5 @@
+// Realize `OneOf` type. It allows to store different types in one variable.
+// OneOf supports also JSON marshalling and unmarshalling.
 package oneof
 
 import (

diff --git a/ptr/ptr.go b/ptr/ptr.go
@@ -1,3 +1,4 @@
+// Package ptr contains functions for simplified creation of pointers from constants of basic types.
 package ptr
 
 import (

diff --git a/sync/semaphore.go b/sync/semaphore.go
@@ -1,4 +1,4 @@
-// Package semaphore provides a weighted semaphore implementation.
+// Package semaphore provides a semaphore implementation.
 package sync
 
 import "context"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package contains functions that simplify operations with maps, slices, sets, groups.
		package collections