Add some more documentation and links to godoc#

This commit is contained in:
Melody Becker 2025-04-28 08:49:13 +02:00
parent fa857615dd
commit 4b8a62ba12
Signed by: mstar
SSH key fingerprint: SHA256:9VAo09aaVNTWKzPW7Hq2LW+ox9OdwmTSHRoD4mlz1yI
8 changed files with 13 additions and 1 deletions

View file

@ -1,5 +1,8 @@
# GoUtils
![Go Coverage](https://git.mstar.dev/mstar/goutils/raw/branch/main/coverage_badge.png) [![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://git.mstar.dev/mstar/goutils/src/branch/main/LICENSE)
![Go Coverage](https://git.mstar.dev/mstar/goutils/raw/branch/main/coverage_badge.png)
[![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://git.mstar.dev/mstar/goutils/src/branch/main/LICENSE)
[![Go Documentation](https://godocs.io/git.mstar.dev/mstar/goutils?status.svg)](https://godocs.io/git.mstar.dev/mstar/goutils)
[![GoDoc](https://pkg.go.dev/badge/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.

View file

@ -1,3 +1,4 @@
// Package containers contains implementations of a generic queue and stack
package containers
type chainElem[T any] struct {

View file

@ -1,3 +1,5 @@
// Package embedFsWrapper contains a wrapper around [io/fs.FS] for working
// around a limitation of the [embed] package
package embedFsWrapper
import (

View file

@ -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
import (

View file

@ -1,3 +1,4 @@
// Package maputils contains various generic functions for applying an operation on an entire map
package maputils
import "git.mstar.dev/mstar/goutils/sliceutils"

View file

@ -1,3 +1,4 @@
// Package mathutils contains helper functions for performing common mathematical operations
package mathutils
type SignedNumber interface {

View file

@ -1,3 +1,4 @@
// Package other contains various funtions that didn't fit into any of the other packages
package other
import "fmt"

View file

@ -1,3 +1,4 @@
// Package sliceutils contains various generic functions for applying an operation across an entire slice
package sliceutils
// MapS applies a given function to every element of a slice.