#109 Prepare for versioned release

senzing-garage · Sep 3, 2024 · 6651ebf · 6651ebf
1 parent b913167
commit 6651ebf
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
-## [1.5.0] - 2024-06-10
+## [1.5.0] - 2024-09-03
 
 ### Changed in 1.5.0
 
@@ -203,7 +203,6 @@ and this project adheres to [Semantic Versioning].
 
 - Initial implementation
 
-
 [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
 [markdownlint]: https://dlaa.me/markdownlint/
 [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
diff --git a/doc.go b/doc.go
@@ -37,7 +37,10 @@ Output:
 
 For examples, visit:
 
-- [Examples](https://github.com/senzing-garage/go-logging/blob/main/docs/examples.md)
-- [main.go](https://github.com/senzing-garage/go-logging/blob/main/main.go)
+  - [Examples] is a short tutorial on using go-logging
+  - [main.go] has a working Go program
+
+[Examples]: https://github.com/senzing-garage/go-logging/blob/main/docs/examples.md
+[main.go]: https://github.com/senzing-garage/go-logging/blob/main/main.go
 */
 package main
diff --git a/go.mod b/go.mod
@@ -5,7 +5,7 @@ go 1.21
 require (
 	github.com/senzing-garage/go-messaging v1.5.1
 	github.com/stretchr/testify v1.9.0
-	golang.org/x/exp v0.0.0-20240604190554-fc45aab8b7f8
+	golang.org/x/exp v0.0.0-20240823005443-9b4947da3948
 )
 
 require (

diff --git a/go.sum b/go.sum
@@ -6,8 +6,8 @@ github.com/senzing-garage/go-messaging v1.5.1 h1:rvBP06mURgUQV8xNRKZ1V1pkMLbXizd
 github.com/senzing-garage/go-messaging v1.5.1/go.mod h1:W93FrFoYrJWQ1302jgY8U5ylSA0whAOCLo1x1ESbVX4=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
-golang.org/x/exp v0.0.0-20240604190554-fc45aab8b7f8 h1:LoYXNGAShUG3m/ehNk4iFctuhGX/+R1ZpfJ4/ia80JM=
-golang.org/x/exp v0.0.0-20240604190554-fc45aab8b7f8/go.mod h1:jj3sYF3dwk5D+ghuXyeI3r5MFf+NT2An6/9dOA95KSI=
+golang.org/x/exp v0.0.0-20240823005443-9b4947da3948 h1:kx6Ds3MlpiUHKj7syVnbp57++8WpuKPcR5yjLBjvLEA=
+golang.org/x/exp v0.0.0-20240823005443-9b4947da3948/go.mod h1:akd2r19cwCdwSwWeIdzYQGa/EZZyqcOdwWiwj5L5eKQ=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

diff --git a/logger/doc.go b/logger/doc.go
@@ -0,0 +1,4 @@
+/*
+Package logger is a decorator over Go's log package.
+*/
+package logger
diff --git a/logger/logger_basic.go b/logger/logger_basic.go
@@ -1,12 +1,10 @@
 /*
-The logger package is a decorator over Go's log package.
-
-The LoggerDefault implementation  provides a layer over go's log to
+The [BasicLogger] implementation of the [Logger] interface
+provides a layer over go's log to
 add Trace, Debug, Info, Warn, Error, Fatal, and Panic levels.
+It also implements IsXxxx() functions that can be used as [guards].
 
-It also implements IsXxxx() functions
-that can be used as guards
-(https://en.wikipedia.org/wiki/Guard_(computer_science))
+[guards]: https://en.wikipedia.org/wiki/Guard_(computer_science)
 */
 package logger
 

diff --git a/logger/main.go b/logger/main.go
@@ -1,6 +1,4 @@
 /*
-The logger package is a decorator over Go's log package.
-
 For examples of use, see https://github.com/senzing-garage/go-logging/blob/main/logger/logger_test.go
 */
 package logger

diff --git a/logging/doc.go b/logging/doc.go
@@ -1,4 +1,10 @@
 /*
-The logging package ...
+Package logging is used to create loggers with guard methods.
+
+The [guard] methods can be used to avoid calls to logging functions
+that would be ignored due to logging level.
+This avoids long computations for log messages that would be discarded anyway.
+
+[guard]: https://en.wikipedia.org/wiki/Guard_(computer_science)
 */
 package logging
diff --git a/logging/main.go b/logging/main.go
@@ -1,3 +1,8 @@
+/*
+The [Logging] interface lists the methods available to a Logging object.
+
+For examples of use, see https://github.com/senzing-garage/go-logging/blob/main/logger/logger_test.go
+*/
 package logging
 
 import (

diff --git a/main.go b/main.go
@@ -1,6 +1,3 @@
-/*
-go-logging/main.go implements examples.
-*/
 package main
 
 import (