issue #5 - cosmetic edits to API doc

Sage · Sep 18, 2014 · e1ea283 · e1ea283
1 parent 85d8d58
commit e1ea283
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/lib/helpers/binary._js b/lib/helpers/binary._js
@@ -11,7 +11,7 @@ var NUMBERS = [//
 ['Float', 4], ['Double', 8]];
 
 /// 
-/// ###
+/// ----
 /// 
 /// * `reader = ez.helpers.binary.reader(reader, options)`  
 ///   Wraps a raw buffer reader and returns a reader with additional API to handle binary streams.  
@@ -77,7 +77,7 @@ Reader.prototype.peek = function(_, len) {
 }
 
 /// 
-/// * reader.unread(len)`  
+/// * `reader.unread(len)`  
 ///   Unread the last `len` bytes read.  
 ///   `len` cannot exceed the size of the last read.
 Reader.prototype.unread = function(len) {
@@ -117,7 +117,7 @@ function numberReader(name, len, peekOnly) {
 }
 
 /// 
-/// ###
+/// ----
 /// 
 /// * `writer = ez.helpers.binary.writer(writer, options)`  
 ///   Wraps a raw buffer writer and returns a writer with additional API to handle binary streams.

diff --git a/lib/helpers/binary.md b/lib/helpers/binary.md
@@ -2,7 +2,7 @@
 
 `var ez = require("ez-streams")`  
 
-###
+----
 
 * `reader = ez.helpers.binary.reader(reader, options)`  
   Wraps a raw buffer reader and returns a reader with additional API to handle binary streams.  
@@ -20,7 +20,7 @@
   Same as `read` but does not advance the read pointer.  
   Another `read` would read the same data again.
 
-* reader.unread(len)`  
+* `reader.unread(len)`  
   Unread the last `len` bytes read.  
   `len` cannot exceed the size of the last read.
 
@@ -44,7 +44,7 @@
 * `val = reader.peekDouble(_)`  
   Specialized peekers for numbers.
 
-###
+----
 
 * `writer = ez.helpers.binary.writer(writer, options)`  
   Wraps a raw buffer writer and returns a writer with additional API to handle binary streams.