Bläddra i källkod

Consistent opening blurb.

Peter H. Froehlich 8 år sedan
förälder
incheckning
8ce15f27e0
2 ändrade filer med 10 tillägg och 9 borttagningar
  1. 6 5
      README.md
  2. 4 4
      queue/queue.go

+ 6 - 5
README.md

@@ -3,12 +3,13 @@
 [![GoDoc](https://godoc.org/github.com/phf/go-queue/queue?status.png)](http://godoc.org/github.com/phf/go-queue/queue)
 [![Go Report Card](https://goreportcard.com/badge/github.com/phf/go-queue)](https://goreportcard.com/report/github.com/phf/go-queue)
 
-A double-ended queue (aka "deque") built on top of a slice.
-All operations are (amortized) constant time.
+Package `queue` implements a double-ended queue (aka "deque") data structure
+on top of a slice.
+All operations run in (amortized) constant time.
 Benchmarks compare favorably to
-[container/list](https://golang.org/pkg/container/list/) as
-well as to Go's channels.
-Not safe for concurrent use.
+[container/list](https://golang.org/pkg/container/list/) as well as to
+Go's channels.
+These queues are not safe for concurrent use.
 
 I tried to stick to the conventions established by
 [container/list](https://golang.org/pkg/container/list/)

+ 4 - 4
queue/queue.go

@@ -2,10 +2,10 @@
 // Use of this source code is governed by a BSD-style license
 // that can be found in the LICENSE file.
 
-// Package queue implements a double-ended queue (aka "deque") on top of a
-// slice. All operations are (amortized) constant time. Benchmarks compare
-// favorably to container/list as well as to Go's channels. Not safe for
-// concurrent use.
+// Package queue implements a double-ended queue (aka "deque") data structure
+// on top of a slice. All operations run in (amortized) constant time.
+// Benchmarks compare favorably to container/list as well as to Go's channels.
+// These queues are not safe for concurrent use.
 package queue
 
 import (