Skip to content

Commit 24868ca

Browse files
authored
Fix docs wording (#7)
1 parent bba865c commit 24868ca

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
[![Go Report Card](https://goreportcard.com/badge/github.com/diegommm/adaptivepool)](https://goreportcard.com/report/github.com/diegommm/adaptivepool)
44
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/2a3bd79d8ed64cb5bd30ffae9e4f0486)](https://app.codacy.com/gh/diegommm/adaptivepool/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
55

6-
# Stochastic free list based on sync.Pool
6+
# Statistical free list based on sync.Pool
77

88
Package **adaptivepool** provides a free list based on
9-
[sync.Pool](https://pkg.go.dev/sync#Pool) that can stochastically define which
10-
items should be reused and how they should be pre-allocated, based on a set of
11-
online stats of a measure of choice called cost.
9+
[sync.Pool](https://pkg.go.dev/sync#Pool) that can determine which items should
10+
be reused and how they should be pre-allocated based on a set of online stats of
11+
a measure of choice called cost.
1212

1313
Example usage of `AdaptivePool`:
1414

doc.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Package adaptivepool provides a free list based on [sync.Pool] that can
2-
// stochastically define which items should be reused, based on a measure of
3-
// choice called cost. It also provides a bufferer for io.Reader and
4-
// io.ReadCloser based on this free list. Unless stated otherwise, the
5-
// documentation of sync.Pool is also valid for the implementation in this
6-
// package.
2+
// determine which items should be reused and how they should be pre-allocated
3+
// based on a set of online stats of a measure of choice called cost. It also
4+
// provides a bufferer for io.Reader and io.ReadCloser based on this free list.
5+
// Unless stated otherwise, the documentation of sync.Pool is also valid for the
6+
// implementation in this package.
77
package adaptivepool

0 commit comments

Comments
 (0)