Skip to content

Commit 90fc496

Browse files
Trottjasnell
authored andcommitted
doc: fix punctuation and wrapping in buffer.md
Remove unnecessary colons and wrap lines at 80 characters. PR-URL: #19964 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent c29f2f2 commit 90fc496

File tree

1 file changed

+47
-25
lines changed

1 file changed

+47
-25
lines changed

doc/api/buffer.md

Lines changed: 47 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1509,7 +1509,8 @@ changes:
15091509
uint32 anymore.
15101510
-->
15111511

1512-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`.
1512+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1513+
satisfy `0 <= offset <= buf.length - 8`.
15131514
* Returns: {number}
15141515

15151516
Reads a 64-bit double from `buf` at the specified `offset` with specified
@@ -1541,7 +1542,8 @@ changes:
15411542
uint32 anymore.
15421543
-->
15431544

1544-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 4`.
1545+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1546+
satisfy `0 <= offset <= buf.length - 4`.
15451547
* Returns: {number}
15461548

15471549
Reads a 32-bit float from `buf` at the specified `offset` with specified
@@ -1572,7 +1574,8 @@ changes:
15721574
uint32 anymore.
15731575
-->
15741576

1575-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 1`.
1577+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1578+
satisfy `0 <= offset <= buf.length - 1`.
15761579
* Returns: {integer}
15771580

15781581
Reads a signed 8-bit integer from `buf` at the specified `offset`.
@@ -1601,7 +1604,8 @@ changes:
16011604
uint32 anymore.
16021605
-->
16031606

1604-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 2`.
1607+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1608+
satisfy `0 <= offset <= buf.length - 2`.
16051609
* Returns: {integer}
16061610

16071611
Reads a signed 16-bit integer from `buf` at the specified `offset` with
@@ -1632,7 +1636,8 @@ changes:
16321636
uint32 anymore.
16331637
-->
16341638

1635-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 4`.
1639+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1640+
satisfy `0 <= offset <= buf.length - 4`.
16361641
* Returns: {integer}
16371642

16381643
Reads a signed 32-bit integer from `buf` at the specified `offset` with
@@ -1663,8 +1668,10 @@ changes:
16631668
byteLength to uint32 anymore.
16641669
-->
16651670

1666-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - byteLength`.
1667-
* `byteLength` {integer} Number of bytes to read. Must satisfy: `0 < byteLength <= 6`.
1671+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1672+
satisfy `0 <= offset <= buf.length - byteLength`.
1673+
* `byteLength` {integer} Number of bytes to read. Must satisfy
1674+
`0 < byteLength <= 6`.
16681675
* Returns: {integer}
16691676

16701677
Reads `byteLength` number of bytes from `buf` at the specified `offset`
@@ -1694,7 +1701,8 @@ changes:
16941701
uint32 anymore.
16951702
-->
16961703

1697-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 1`.
1704+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1705+
satisfy `0 <= offset <= buf.length - 1`.
16981706
* Returns: {integer}
16991707

17001708
Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
@@ -1721,7 +1729,8 @@ changes:
17211729
uint32 anymore.
17221730
-->
17231731

1724-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 2`.
1732+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1733+
satisfy `0 <= offset <= buf.length - 2`.
17251734
* Returns: {integer}
17261735

17271736
Reads an unsigned 16-bit integer from `buf` at the specified `offset` with
@@ -1754,7 +1763,8 @@ changes:
17541763
uint32 anymore.
17551764
-->
17561765

1757-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 4`.
1766+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1767+
satisfy `0 <= offset <= buf.length - 4`.
17581768
* Returns: {integer}
17591769

17601770
Reads an unsigned 32-bit integer from `buf` at the specified `offset` with
@@ -1783,8 +1793,10 @@ changes:
17831793
byteLength to uint32 anymore.
17841794
-->
17851795

1786-
* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - byteLength`.
1787-
* `byteLength` {integer} Number of bytes to read. Must satisfy: `0 < byteLength <= 6`.
1796+
* `offset` {integer} Number of bytes to skip before starting to read. Must
1797+
satisfy `0 <= offset <= buf.length - byteLength`.
1798+
* `byteLength` {integer} Number of bytes to read. Must satisfy
1799+
`0 < byteLength <= 6`.
17881800
* Returns: {integer}
17891801

17901802
Reads `byteLength` number of bytes from `buf` at the specified `offset`
@@ -2095,7 +2107,8 @@ changes:
20952107
-->
20962108

20972109
* `value` {number} Number to be written to `buf`.
2098-
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`.
2110+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2111+
satisfy `0 <= offset <= buf.length - 8`.
20992112
* Returns: {integer} `offset` plus the number of bytes written.
21002113

21012114
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2129,7 +2142,8 @@ changes:
21292142
-->
21302143

21312144
* `value` {number} Number to be written to `buf`.
2132-
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 4`.
2145+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2146+
satisfy `0 <= offset <= buf.length - 4`.
21332147
* Returns: {integer} `offset` plus the number of bytes written.
21342148

21352149
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2162,7 +2176,8 @@ changes:
21622176
-->
21632177

21642178
* `value` {integer} Number to be written to `buf`.
2165-
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 1`.
2179+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2180+
satisfy `0 <= offset <= buf.length - 1`.
21662181
* Returns: {integer} `offset` plus the number of bytes written.
21672182

21682183
Writes `value` to `buf` at the specified `offset`. `value` *should* be a valid
@@ -2193,7 +2208,8 @@ changes:
21932208
-->
21942209

21952210
* `value` {integer} Number to be written to `buf`.
2196-
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 2`.
2211+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2212+
satisfy `0 <= offset <= buf.length - 2`.
21972213
* Returns: {integer} `offset` plus the number of bytes written.
21982214

21992215
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2225,7 +2241,8 @@ changes:
22252241
-->
22262242

22272243
* `value` {integer} Number to be written to `buf`.
2228-
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 4`.
2244+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2245+
satisfy `0 <= offset <= buf.length - 4`.
22292246
* Returns: {integer} `offset` plus the number of bytes written.
22302247

22312248
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2257,8 +2274,10 @@ changes:
22572274
-->
22582275

22592276
* `value` {integer} Number to be written to `buf`.
2260-
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - byteLength`.
2261-
* `byteLength` {integer} Number of bytes to write. Must satisfy: `0 < byteLength <= 6`.
2277+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2278+
satisfy `0 <= offset <= buf.length - byteLength`.
2279+
* `byteLength` {integer} Number of bytes to write. Must satisfy
2280+
`0 < byteLength <= 6`.
22622281
* Returns: {integer} `offset` plus the number of bytes written.
22632282

22642283
Writes `byteLength` bytes of `value` to `buf` at the specified `offset`.
@@ -2290,7 +2309,8 @@ changes:
22902309
-->
22912310

22922311
* `value` {integer} Number to be written to `buf`.
2293-
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 1`.
2312+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2313+
satisfy `0 <= offset <= buf.length - 1`.
22942314
* Returns: {integer} `offset` plus the number of bytes written.
22952315

22962316
Writes `value` to `buf` at the specified `offset`. `value` *should* be a
@@ -2321,7 +2341,8 @@ changes:
23212341
-->
23222342

23232343
* `value` {integer} Number to be written to `buf`.
2324-
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 2`.
2344+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2345+
satisfy `0 <= offset <= buf.length - 2`.
23252346
* Returns: {integer} `offset` plus the number of bytes written.
23262347

23272348
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2357,7 +2378,8 @@ changes:
23572378
-->
23582379

23592380
* `value` {integer} Number to be written to `buf`.
2360-
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 4`.
2381+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2382+
satisfy `0 <= offset <= buf.length - 4`.
23612383
* Returns: {integer} `offset` plus the number of bytes written.
23622384

23632385
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2391,9 +2413,9 @@ changes:
23912413
-->
23922414

23932415
* `value` {integer} Number to be written to `buf`.
2394-
* `offset` {integer} Number of bytes to skip before starting to write.
2395-
Must satisfy: `0 <= offset <= buf.length - byteLength`.
2396-
* `byteLength` {integer} Number of bytes to write. Must satisfy:
2416+
* `offset` {integer} Number of bytes to skip before starting to write. Must
2417+
satisfy `0 <= offset <= buf.length - byteLength`.
2418+
* `byteLength` {integer} Number of bytes to write. Must satisfy
23972419
`0 < byteLength <= 6`.
23982420
* Returns: {integer} `offset` plus the number of bytes written.
23992421

0 commit comments

Comments
 (0)