small docs enhancement

philiplb · Sep 26, 2020 · 7448ec8 · 7448ec8
1 parent 42e3222
commit 7448ec8
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/runereader.go b/runereader.go
@@ -8,7 +8,8 @@
  */
 
 // Package peekabuf offers buffers with the capability to be peeked without
-// interfering  the read function.
+// side effects on the unread functionality. Along with that, it returns a
+// special `EOF` rune instead of an error if it reaches the end of the buffer.
 package peekabuf
 
 import (