doc: note that buf.buffer's contents might differ

strugee · MylesBorins · commit 5334f59519f7 · 2019-12-17T17:07:01.000-05:00
This bit me in a personal project since I had no reason to read the `buf.byteOffset` docs, so point readers there explicitly. PR-URL: #29651 Reviewed-By: Anna Henningsen <anna@addaleax.net>
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -1025,6 +1025,9 @@ console.log(buf.toString('ascii'));
 * {ArrayBuffer} The underlying `ArrayBuffer` object based on
   which this `Buffer` object is created.
 
+This `ArrayBuffer` is not guaranteed to correspond exactly to the original
+`Buffer`. See the notes on `buf.byteOffset` for details.
+
 ```js
 const arrayBuffer = new ArrayBuffer(16);
 const buffer = Buffer.from(arrayBuffer);
