Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: improve 'hex' Buffer decoding description and examples #41598

Merged
merged 4 commits into from
Jan 21, 2022
Merged

doc: improve 'hex' Buffer decoding description and examples #41598

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ccd7221
doc: add missing word in `'hex'` Buffer decoding description
gioragutt Jan 19, 2022
7c9c04b
fix max line width lint issue
gioragutt Jan 19, 2022
eb2fcf5
Update buffer.md
gioragutt Jan 19, 2022
02371aa
Update buffer.md
gioragutt Jan 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,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.
Comment on lines 177 to +179
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional nit-pick suggestion: The Microsoft style guide we follow suggests might instead of may in this context. But I wonder if it's actually will occur rather than might occur? All told:

Suggested change
* `'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.
* `'hex'`: Encode each byte as two hexadecimal characters. Data is truncated
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:

Expand All @@ -201,11 +201,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');
Expand All @@ -215,11 +215,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');
Expand Down