Skip to content

Commit e82b72a

Browse files
committed
Minor docs tweaks
1 parent a3cfffe commit e82b72a

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

progress.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
// Package dspc provides a progress counter for tracking and displaying
2-
// real-time progress of concurrent operations in terminal apps.
3-
// It's minimalistic, lock-free, zero-allocation and provides in-place pretty-printing out of the box.
1+
// Package dspc provides tools for tracking progress of concurrent operations in a terminal.
42
package dspc
53

64
import (
@@ -13,11 +11,12 @@ import (
1311
"time"
1412
)
1513

16-
// Progress tracks multiple named counters. It's like a concurrent map[string]int64
17-
// but optimized for progress tracking with small, stable sets of keys (typically
14+
// Progress tracks multiple named counters. It's similar to a concurrent map[string]int64
15+
// but optimized for progress tracking for a small stable sets of keys (typically
1816
// fitting on a single screen).
1917
//
2018
// All operations are atomic, lock-free and safe for concurrent use.
19+
// Methods do not allocate memory in the hot path.
2120
//
2221
// The zero Progress is empty and ready for use
2322
type Progress struct {

0 commit comments

Comments
 (0)