doc: improve 'hex' Buffer decoding description and examples

gioragutt · danielleadams · commit 5f0a017a020a · 2022-03-14T09:32:01.000-04:00
PR-URL: #41598 Fixes: #41594 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -173,8 +173,8 @@ string into a `Buffer` as decoding.
   encoding a `Buffer` to a string, this encoding will omit padding.
 
 * `'hex'`: Encode each byte as two hexadecimal characters. Data truncation
-  may occur when decoding strings that do exclusively contain valid hexadecimal
-  characters. See below for an example.
+  may occur when decoding strings that do not exclusively consist of an even
+  number of hexadecimal characters. See below for an example.
 
 The following legacy character encodings are also supported:
 
@@ -199,11 +199,11 @@ The following legacy character encodings are also supported:
 ```mjs
 import { Buffer } from 'buffer';
 
-Buffer.from('1ag', 'hex');
+Buffer.from('1ag123', 'hex');
 // Prints <Buffer 1a>, data truncated when first non-hexadecimal value
 // ('g') encountered.
 
-Buffer.from('1a7g', 'hex');
+Buffer.from('1a7', 'hex');
 // Prints <Buffer 1a>, data truncated when data ends in single digit ('7').
 
 Buffer.from('1634', 'hex');
@@ -213,11 +213,11 @@ Buffer.from('1634', 'hex');
 ```cjs
 const { Buffer } = require('buffer');
 
-Buffer.from('1ag', 'hex');
+Buffer.from('1ag123', 'hex');
 // Prints <Buffer 1a>, data truncated when first non-hexadecimal value
 // ('g') encountered.
 
-Buffer.from('1a7g', 'hex');
+Buffer.from('1a7', 'hex');
 // Prints <Buffer 1a>, data truncated when data ends in single digit ('7').
 
 Buffer.from('1634', 'hex');
