iamthefij/slog
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docs for new package path

Browse Source
This commit is contained in:
IamTheFij 2021-04-27 16:38:25 -07:00
parent f79002168e
commit 7b1a0ac5f8
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -18,5 +18,5 @@ check:
pre-commit run --all-files pre-commit run --all-files
README.md: ./add-docs-to-readme.sh *.go README.md: ./add-docs-to-readme.sh *.go go.mod
./add-docs-to-readme.sh ./add-docs-to-readme.sh

2
README.md
View File

@ -11,7 +11,7 @@ Slog lets you hide or show debug logs as well as provides a simpler way to log m
Also provided are a few simple methods for handling returned `error` variables, logging them out and optionally panicing or fatally exiting. Also provided are a few simple methods for handling returned `error` variables, logging them out and optionally panicing or fatally exiting.
## Documentation ## Documentation
package slog // import "git.iamthefij.com/iamthefij/slog" package slog // import "git.iamthefij.com/iamthefij/slog/v2"
Package slog is a super simple logger that allows a few convenience methods Package slog is a super simple logger that allows a few convenience methods
for handling debug vs warning/error logs. It also adds a few conveniences for handling debug vs warning/error logs. It also adds a few conveniences

2
add-docs-to-readme.sh
View File

@ -4,5 +4,5 @@ set -e
slogdir=$(dirname "$0") slogdir=$(dirname "$0")
readme="$slogdir/README.md" readme="$slogdir/README.md"
awk '/## Documentation/ {print ; exit} {print}' "$readme" > "$readme.tmp" && go doc -all slog | sed "s/^/ /;s/[ \t]*$//" >> "$readme.tmp" awk '/## Documentation/ {print ; exit} {print}' "$readme" > "$readme.tmp" && go doc -all slog/v2 | sed "s/^/ /;s/[ \t]*$//" >> "$readme.tmp"
mv "$readme.tmp" "$readme" mv "$readme.tmp" "$readme"