doc: clarifying variables in fs.write()

This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: #9792 Ref: #7868 Reviewed-By: Sam Roberts <[email protected]>
nodejs · Jan 18, 2017 · 762f260 · 762f260
1 parent 622b439
commit 762f260
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -1832,7 +1832,8 @@ added: v0.0.2
 
 Write `buffer` to the file specified by `fd`.
 
-`offset` and `length` determine the part of the buffer to be written.
+`offset` determines the part of the buffer to be written, and `length` is
+an integer specifying the number of bytes to write.
 
 `position` refers to the offset from the beginning of the file where this data
 should be written. If `typeof position !== 'number'`, the data will be written