Merge remote-tracking branch 'origin/main'

# Conflicts:
#	README.md

Author: roeldev

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 2
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "thursday"
+    open-pull-requests-limit: 2

.github/workflows/lint.yml

@@ -10,6 +10,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
       - uses: golangci/golangci-lint-action@v3

.github/workflows/test.yml

@@ -15,8 +15,8 @@ jobs:
     runs-on: ${{ matrix.platform }}
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go-version }}
 

README.md

@@ -7,30 +7,41 @@ writing
 [![Documentation][doc-img]][doc-url]
 
 [latest-release-img]: https://img.shields.io/github/release/go-pogo/writing.svg?label=latest
+
 [latest-release-url]: https://github.com/go-pogo/writing/releases
+
 [build-status-img]: https://github.com/go-pogo/writing/workflows/Test/badge.svg
+
 [build-status-url]: https://github.com/go-pogo/writing/actions/workflows/test.yml
+
 [report-img]: https://goreportcard.com/badge/github.com/go-pogo/writing
+
 [report-url]: https://goreportcard.com/report/github.com/go-pogo/writing
+
 [doc-img]: https://godoc.org/github.com/go-pogo/writing?status.svg
+
 [doc-url]: https://pkg.go.dev/github.com/go-pogo/writing
 
 Package `writing`.
 
 ```sh
 go get github.com/go-pogo/writing
 ```
+
 ```go
 import "github.com/go-pogo/writing"
 ```
 
 ## Documentation
+
 Additional detailed documentation is available at [pkg.go.dev][doc-url]
 
 ## Created with
+
 <a href="https://www.jetbrains.com/?from=go-pogo" target="_blank"><img src="https://resources.jetbrains.com/storage/products/company/brand/logos/GoLand_icon.png" width="35" /></a>
 
 ## License
-Copyright © 2022-2023 [Roel Schut](https://roelschut.nl). All rights reserved.
+
+Copyright © 2022-2024 [Roel Schut](https://roelschut.nl). All rights reserved.
 
 This project is governed by a BSD-style license that can be found in the [LICENSE](LICENSE) file.

bytes.go

@@ -9,24 +9,32 @@ import (
 	"sync"
 )
 
+// A BytesBufferPool is a sync.Pool which stores bytes.Buffer(s).
 type BytesBufferPool struct {
 	p sync.Pool
 }
 
+// NewBytesBufferPool creates a new BytesBufferPool with a given initial
+// capacity n for each retrieved bytes.Buffer.
 func NewBytesBufferPool(n int) *BytesBufferPool {
 	return &BytesBufferPool{p: sync.Pool{
 		New: func() interface{} {
 			var buf bytes.Buffer
-			buf.Grow(n)
+			if n != 0 {
+				buf.Grow(n)
+			}
 			return &buf
 		},
 	}}
 }
 
+// Get selects an arbitrary bytes.Buffer from the BytesBufferPool, removes it
+// from the pool, and returns it to the caller.
 func (p *BytesBufferPool) Get() *bytes.Buffer {
 	return p.p.Get().(*bytes.Buffer)
 }
 
+// Put adds the bytes.Buffer b to the pool.
 func (p *BytesBufferPool) Put(b *bytes.Buffer) {
 	b.Reset()
 	p.p.Put(b)