doc: document max `new Buffer(size)`
authorJackson Tian <shyvo1987@gmail.com>
Wed, 6 Aug 2014 06:35:35 +0000 (14:35 +0800)
committerTimothy J Fontaine <tjfontaine@gmail.com>
Thu, 7 Aug 2014 23:47:01 +0000 (16:47 -0700)
Signed-off-by: Timothy J Fontaine <tjfontaine@gmail.com>
doc/api/buffer.markdown

index 3e6289e..b384b05 100644 (file)
@@ -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)