From de70a363ebf551d9dc0ad7253928fa3144843f2f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 10 Jan 2018 14:00:20 -0800 Subject: [PATCH] doc: be less tentative about undefined behavior MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In the documentation for the buffer module, change instances of "the result is considered undefined behavior" to "the resulting behavior is undefined". It's less ambiguous in meaning and less awkward stylistically. PR-URL: https://github.com/nodejs/node/pull/18091 Reviewed-By: Anna Henningsen Reviewed-By: James M Snell Reviewed-By: Jeremiah Senkpiel Reviewed-By: Colin Ihrig Reviewed-By: Gireesh Punathil Reviewed-By: Daniel Bevenius Reviewed-By: Minwoo Jung Reviewed-By: Khaidi Chu Reviewed-By: Tobias Nießen --- doc/api/buffer.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 41b4e643055af2..1e5b23cb4b9982 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -1583,7 +1583,7 @@ endian format (`readDoubleBE()` returns big endian, `readDoubleLE()` returns little endian). Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Examples: @@ -1619,7 +1619,7 @@ endian format (`readFloatBE()` returns big endian, `readFloatLE()` returns little endian). Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Examples: @@ -1652,7 +1652,7 @@ added: v0.5.0 Reads a signed 8-bit integer from `buf` at the specified `offset`. Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Integers read from a `Buffer` are interpreted as two's complement signed values. @@ -1686,7 +1686,7 @@ the specified endian format (`readInt16BE()` returns big endian, `readInt16LE()` returns little endian). Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Integers read from a `Buffer` are interpreted as two's complement signed values. @@ -1720,7 +1720,7 @@ the specified endian format (`readInt32BE()` returns big endian, `readInt32LE()` returns little endian). Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Integers read from a `Buffer` are interpreted as two's complement signed values. @@ -1755,7 +1755,7 @@ and interprets the result as a two's complement signed value. Supports up to 48 bits of accuracy. Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Examples: @@ -1784,7 +1784,7 @@ added: v0.5.0 Reads an unsigned 8-bit integer from `buf` at the specified `offset`. Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Examples: @@ -1816,7 +1816,7 @@ specified endian format (`readUInt16BE()` returns big endian, `readUInt16LE()` returns little endian). Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Examples: @@ -1854,7 +1854,7 @@ specified endian format (`readUInt32BE()` returns big endian, `readUInt32LE()` returns little endian). Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Examples: @@ -1887,7 +1887,7 @@ and interprets the result as an unsigned integer. Supports up to 48 bits of accuracy. Setting `noAssert` to `true` allows `offset` to be beyond the end of `buf`, but -the result should be considered undefined behavior. +the resulting behavior is undefined. Examples: @@ -2225,7 +2225,7 @@ endian). `value` *should* be a valid 64-bit double. Behavior is undefined when `value` is anything other than a 64-bit double. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. Examples: @@ -2260,7 +2260,7 @@ endian). `value` *should* be a valid 32-bit float. Behavior is undefined when `value` is anything other than a 32-bit float. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. Examples: @@ -2293,7 +2293,7 @@ signed 8-bit integer. Behavior is undefined when `value` is anything other than a signed 8-bit integer. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. `value` is interpreted and written as a two's complement signed integer. @@ -2326,7 +2326,7 @@ endian). `value` *should* be a valid signed 16-bit integer. Behavior is undefine when `value` is anything other than a signed 16-bit integer. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. `value` is interpreted and written as a two's complement signed integer. @@ -2359,7 +2359,7 @@ endian). `value` *should* be a valid signed 32-bit integer. Behavior is undefine when `value` is anything other than a signed 32-bit integer. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. `value` is interpreted and written as a two's complement signed integer. @@ -2393,7 +2393,7 @@ Supports up to 48 bits of accuracy. Behavior is undefined when `value` is anything other than a signed integer. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. Examples: @@ -2426,7 +2426,7 @@ valid unsigned 8-bit integer. Behavior is undefined when `value` is anything other than an unsigned 8-bit integer. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. Examples: @@ -2459,7 +2459,7 @@ endian). `value` should be a valid unsigned 16-bit integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. Examples: @@ -2496,7 +2496,7 @@ endian). `value` should be a valid unsigned 32-bit integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. Examples: @@ -2532,7 +2532,7 @@ Supports up to 48 bits of accuracy. Behavior is undefined when `value` is anything other than an unsigned integer. Setting `noAssert` to `true` allows the encoded form of `value` to extend beyond -the end of `buf`, but the result should be considered undefined behavior. +the end of `buf`, but the resulting behavior is undefined. Examples: