S.O.N.G/deque-int
S.O.N.G/deque-int
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

update readme

Browse source
This commit is contained in:
Andrew Gillis 2018-05-01 00:44:09 -04:00
parent df31e17eb5
commit 40bcfc449d
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -9,6 +9,8 @@ Extremely fast ring-buffer deque ([double-ended queue](https://en.wikipedia.org/
[![GoDoc](https://godoc.org/github.com/gammazero/deque?status.svg)](https://godoc.org/github.com/gammazero/deque)
For a pictorial description, see the [Deque diagram](https://github.com/gammazero/deque/wiki)
## Installation
```
@ -31,8 +33,6 @@ For maximum speed, this deque implementation leaves concurrency safety up to the
Since it is OK for the deque to contain a nil value, it is necessary to either panic or return a second boolean value to indicate the deque is empty, when reading or removing an element. This deque panics when reading from an empty deque. This is a run-time check to help catch programming errors, which may be missed if a second return value is ignored. Simply check Deque.Len() before reading from the deque.
For a pictorial description, see the [Deque diagram](https://github.com/gammazero/deque/wiki)
## Example
```go