Add some more documentation and links to godoc#
This commit is contained in:
parent
fa857615dd
commit
4b8a62ba12
8 changed files with 13 additions and 1 deletions
|
@ -1,5 +1,8 @@
|
||||||
# GoUtils
|
# GoUtils
|
||||||
|
|
||||||
 [](https://git.mstar.dev/mstar/goutils/src/branch/main/LICENSE)
|

|
||||||
|
[](https://git.mstar.dev/mstar/goutils/src/branch/main/LICENSE)
|
||||||
|
[](https://godocs.io/git.mstar.dev/mstar/goutils)
|
||||||
|
[](https://pkg.go.dev/git.mstar.dev/mstar/goutils)
|
||||||
|
|
||||||
A collection of useful functions and structs that I use for my projects.
|
A collection of useful functions and structs that I use for my projects.
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
// Package containers contains implementations of a generic queue and stack
|
||||||
package containers
|
package containers
|
||||||
|
|
||||||
type chainElem[T any] struct {
|
type chainElem[T any] struct {
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
// Package embedFsWrapper contains a wrapper around [io/fs.FS] for working
|
||||||
|
// around a limitation of the [embed] package
|
||||||
package embedFsWrapper
|
package embedFsWrapper
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
// Package webutils contains various functions for easier interaction and common tasks
|
||||||
|
// when working with [net/http.Handler] based webservers
|
||||||
package webutils
|
package webutils
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
// Package maputils contains various generic functions for applying an operation on an entire map
|
||||||
package maputils
|
package maputils
|
||||||
|
|
||||||
import "git.mstar.dev/mstar/goutils/sliceutils"
|
import "git.mstar.dev/mstar/goutils/sliceutils"
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
// Package mathutils contains helper functions for performing common mathematical operations
|
||||||
package mathutils
|
package mathutils
|
||||||
|
|
||||||
type SignedNumber interface {
|
type SignedNumber interface {
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
// Package other contains various funtions that didn't fit into any of the other packages
|
||||||
package other
|
package other
|
||||||
|
|
||||||
import "fmt"
|
import "fmt"
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
// Package sliceutils contains various generic functions for applying an operation across an entire slice
|
||||||
package sliceutils
|
package sliceutils
|
||||||
|
|
||||||
// MapS applies a given function to every element of a slice.
|
// MapS applies a given function to every element of a slice.
|
||||||
|
|
Loading…
Reference in a new issue