From 8eb28c3d5006dcefe431e4dfaa3fa8ff6a5bd1f1 Mon Sep 17 00:00:00 2001 From: cjihrig Date: Thu, 19 Nov 2015 12:16:29 -0500 Subject: [PATCH] doc: add reference for buffer.inspect() This commit refers readers to util.inspect() for an explanation of buffer.inspect(). Fixes: https://github.com/nodejs/node/issues/3918 PR-URL: https://github.com/nodejs/node/pull/3921 Reviewed-By: James M Snell Reviewed-By: Brian White --- doc/api/buffer.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/api/buffer.markdown b/doc/api/buffer.markdown index 96a4d3c483efba..52c57010e5ba71 100644 --- a/doc/api/buffer.markdown +++ b/doc/api/buffer.markdown @@ -882,7 +882,8 @@ to `false`. * Number, Default: 50 How many bytes will be returned when `buffer.inspect()` is called. This can -be overridden by user modules. +be overridden by user modules. See [util.inspect()][] for more details on +`buffer.inspect()` behavior. Note that this is a property on the buffer module returned by `require('buffer')`, not on the Buffer global, or a buffer instance. @@ -933,3 +934,4 @@ has actively observed undue memory retention in their applications. [`buf1.compare(buf2)`]: #buffer_buf_compare_otherbuffer [Array#indexOf()]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf +[util.inspect()]: util.html#util_util_inspect_object_options