review fixes: GoDoc comments + CI updates

Author: vakhov

.github/workflows/testing.yml

@@ -29,3 +29,17 @@ jobs:
 
       - name: Run tests with race-detector
         run: make test-race
+
+  golangci-lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/setup-go@v5
+      - uses: actions/checkout@v5
+
+      - name: Install golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: latest
+
+      - name: Run linter
+        run: make lint

LICENCE

@@ -22,4 +22,8 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Portions of this software are derived from the Go standard library,
+Copyright (c) The Go Authors,
+and are used under the terms of the BSD-style license.

Makefile

@@ -3,7 +3,7 @@ GO              ?= go
 GOLANGCI_LINT   ?= golangci-lint
 PKG             := github.com/tarantool/go-tlog
 
-.PHONY: all test test-race test-coverage lint fmt tidy examples help
+.PHONY: all test test-race test-coverage lint fmt tidy help
 
 all: test
 
@@ -31,13 +31,6 @@ fmt:
 tidy:
 	$(GO) mod tidy
 
-## Run all _examples to ensure they compile and run without panic.
-examples:
-	$(GO) run ./_examples/stdout
-	$(GO) run ./_examples/stderr >/dev/null 2>&1 || true
-	$(GO) run ./_examples/file
-	$(GO) run ./_examples/multi
-
 ## Show available targets.
 help:
 	@echo "Available targets:"
@@ -47,4 +40,3 @@ help:
 	@echo "  make lint           - run golangci-lint"
 	@echo "  make fmt            - format sources (gofmt)"
 	@echo "  make tidy           - go mod tidy"
-	@echo "  make examples       - run all examples"

internal/outputs/outputs.go

@@ -92,6 +92,8 @@ func multiClose(files []*os.File) error {
 	return errors.Join(errs...)
 }
 
+// Write writes p to all configured output destinations.
+// It implements io.Writer and is used by slog handlers.
 func (o *Outputs) Write(p []byte) (int, error) {
 	return o.w.Write(p)
 }

internal/slog/buffer.go

@@ -25,6 +25,7 @@ func newBuffer() *buffer {
 	return bufPool.Get().(*buffer)
 }
 
+// Free releases the buffer back to the pool.
 func (b *buffer) Free() {
 	// To reduce peak allocation, return only smaller buffers to the pool.
 	const maxBufferSize = 16 << 10
@@ -34,33 +35,40 @@ func (b *buffer) Free() {
 	}
 }
 
+// Reset clears the buffer contents by setting its length to zero.
 func (b *buffer) Reset() {
 	b.SetLen(0)
 }
 
+// Write appends the provided bytes to the buffer.
 func (b *buffer) Write(p []byte) (int, error) {
 	*b = append(*b, p...)
 	return len(p), nil
 }
 
+// WriteString appends the provided string to the buffer.
 func (b *buffer) WriteString(s string) (int, error) {
 	*b = append(*b, s...)
 	return len(s), nil
 }
 
+// WriteByte appends a single byte to the buffer.
 func (b *buffer) WriteByte(c byte) error {
 	*b = append(*b, c)
 	return nil
 }
 
+// String returns the contents of the buffer as a string.
 func (b *buffer) String() string {
 	return string(*b)
 }
 
+// Len returns the number of bytes currently stored in the buffer.
 func (b *buffer) Len() int {
 	return len(*b)
 }
 
+// SetLen reslices the buffer to the specified length.
 func (b *buffer) SetLen(n int) {
 	*b = (*b)[:n]
 }