doc: deprecate buffer's parent property

`buffer.parent` property is actually an alias of `buffer.buffer` property. This patch actually doc-deprecates it and points the users to the `buffer.buffer` property. PR-URL: #8332 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
nodejs · Jan 18, 2017 · d708700 · d708700
1 parent 03d440e
commit d708700
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -1329,6 +1329,12 @@ buf = buf.slice(0, 5);
 console.log(buf.length);
 ```
 
+### buf.parent
+
+> Stability: 0 - Deprecated: Use [`buf.buffer`] instead.
+
+The `buf.parent` property is a deprecated alias for `buf.buffer`.
+
 ### buf.readDoubleBE(offset[, noAssert])
 ### buf.readDoubleLE(offset[, noAssert])
 <!-- YAML
@@ -2429,6 +2435,7 @@ console.log(buf);
 ```
 
 [`buf.compare()`]: #buffer_buf_compare_target_targetstart_targetend_sourcestart_sourceend
+[`buf.buffer`]: #buffer_buf_buffer
 [`buf.entries()`]: #buffer_buf_entries
 [`buf.indexOf()`]: #buffer_buf_indexof_value_byteoffset_encoding
 [`buf.fill()`]: #buffer_buf_fill_value_offset_end_encoding