summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKyle Robinson Young <kyle@dontkry.com>2012-04-20 22:58:15 -0700
committerBen Noordhuis <info@bnoordhuis.nl>2012-05-01 15:19:36 +0200
commit6ba3e68bd2f9ad582ca0a20e1f42192ab527258e (patch)
tree6aa8b4e93dc95004fa24dec69021d8d5fa0de3de /doc
parentb45a10818e56f8db8d692c5b5abe8bae3a6e0586 (diff)
downloadandroid-node-v8-6ba3e68bd2f9ad582ca0a20e1f42192ab527258e.tar.gz
android-node-v8-6ba3e68bd2f9ad582ca0a20e1f42192ab527258e.tar.bz2
android-node-v8-6ba3e68bd2f9ad582ca0a20e1f42192ab527258e.zip
doc: correct return value of string-based fs.readSync
Closes #2330
Diffstat (limited to 'doc')
-rw-r--r--doc/api/fs.markdown4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown
index 96bef91eb5..8e75a4c44f 100644
--- a/doc/api/fs.markdown
+++ b/doc/api/fs.markdown
@@ -370,8 +370,8 @@ Synchronous version of buffer-based `fs.read`. Returns the number of
## fs.readSync(fd, length, position, encoding)
-Synchronous version of string-based `fs.read`. Returns the number of
-`bytesRead`.
+Legacy synchronous version of string-based `fs.read`. Returns an array with the
+data from the file specified and number of bytes read, `[string, bytesRead]`.
## fs.readFile(filename, [encoding], [callback])