Skip to content

Commit

Permalink
Fix docs wording (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
diegommm authored Oct 28, 2024
1 parent bba865c commit 24868ca
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/diegommm/adaptivepool)](https://goreportcard.com/report/github.com/diegommm/adaptivepool)
[![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)

# Stochastic free list based on sync.Pool
# Statistical free list based on sync.Pool

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

Example usage of `AdaptivePool`:

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

0 comments on commit 24868ca

Please sign in to comment.