doc: document max new Buffer(size)

Signed-off-by: Timothy J Fontaine <tjfontaine@gmail.com>
nodejs · Aug 7, 2014 · 4516e6d · 4516e6d
1 parent a5778cd
commit 4516e6d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/doc/api/buffer.markdown b/doc/api/buffer.markdown
@@ -62,7 +62,9 @@ It can be constructed in a variety of ways.
 
 * `size` Number
 
-Allocates a new buffer of `size` octets.
+Allocates a new buffer of `size` octets. Note, `size` must be no more than
+[kMaxLength](smalloc.html#smalloc_smalloc_kmaxlength). Otherwise, a `RangeError`
+will be thrown here.
 
 ### new Buffer(array)