From 902c3976416b95b90300b6f0a272c891db4a7f91 Mon Sep 17 00:00:00 2001 From: Ian Fijolek Date: Thu, 29 Apr 2021 09:22:39 -0700 Subject: [PATCH] Revert "Update docs for new package path" This reverts commit 7b1a0ac5f8b3b6062b51928bc52f751bfc4fcf1c. --- Makefile | 2 +- README.md | 2 +- add-docs-to-readme.sh | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 35e59eb..8a8eee5 100644 --- a/Makefile +++ b/Makefile @@ -18,5 +18,5 @@ check: pre-commit run --all-files -README.md: ./add-docs-to-readme.sh *.go go.mod +README.md: ./add-docs-to-readme.sh *.go ./add-docs-to-readme.sh diff --git a/README.md b/README.md index b0e375b..ef1d9b7 100644 --- a/README.md +++ b/README.md @@ -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. ## Documentation - package slog // import "git.iamthefij.com/iamthefij/slog/v2" + package slog // import "git.iamthefij.com/iamthefij/slog" 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 diff --git a/add-docs-to-readme.sh b/add-docs-to-readme.sh index cb65fed..2c2f74d 100755 --- a/add-docs-to-readme.sh +++ b/add-docs-to-readme.sh @@ -4,5 +4,5 @@ set -e slogdir=$(dirname "$0") readme="$slogdir/README.md" -awk '/## Documentation/ {print ; exit} {print}' "$readme" > "$readme.tmp" && go doc -all slog/v2 | sed "s/^/ /;s/[ \t]*$//" >> "$readme.tmp" +awk '/## Documentation/ {print ; exit} {print}' "$readme" > "$readme.tmp" && go doc -all slog | sed "s/^/ /;s/[ \t]*$//" >> "$readme.tmp" mv "$readme.tmp" "$readme"