Doc improvements
authorRyan Dahl <ry@tinyclouds.org>
Fri, 3 Jun 2011 11:19:06 +0000 (13:19 +0200)
committerRyan Dahl <ry@tinyclouds.org>
Fri, 3 Jun 2011 11:27:35 +0000 (13:27 +0200)
Fixes #1147.
Fixes #1139.
Fixes #1126.
Thanks ctide, kext, disfated.

doc/api/crypto.markdown
doc/api/fs.markdown
doc/api/util.markdown

index cefbd7b..b47808b 100644 (file)
@@ -108,7 +108,7 @@ The `output_decoding` specifies in what format to return the deciphered plaintex
 ### decipher.final(output_encoding='binary')
 
 Returns any remaining plaintext which is deciphered,
-with `output_encoding' being one of: `'binary'`, `'ascii'` or `'utf8'`.
+with `output_encoding` being one of: `'binary'`, `'ascii'` or `'utf8'`.
 
 
 ### crypto.createSign(algorithm)
index 506883b..dd4f1a9 100644 (file)
@@ -103,14 +103,15 @@ See the [fs.Stats](#fs.Stats) section below for more information.
 ### fs.lstat(path, [callback])
 
 Asynchronous lstat(2). The callback gets two arguments `(err, stats)` where
-`stats` is a `fs.Stats` object. lstat() is identical to stat(), except that if
-path is a symbolic link, then the link itself is stat-ed, not the file that it
+`stats` is a `fs.Stats` object. `lstat()` is identical to `stat()`, except that if
+`path` is a symbolic link, then the link itself is stat-ed, not the file that it
 refers to.
 
 ### fs.fstat(fd, [callback])
 
 Asynchronous fstat(2). The callback gets two arguments `(err, stats)` where
-`stats` is a `fs.Stats` object.
+`stats` is a `fs.Stats` object. `fstat()` is identical to `stat()`, except that
+the file to be stat-ed is specified by the file descriptor `fd`.
 
 ### fs.statSync(path)
 
index 0935860..fdeb5b0 100644 (file)
@@ -16,7 +16,7 @@ output `string` immediately to `stderr`.
 
 Output with timestamp on `stdout`.
 
-    require('util').log('Timestmaped message.');
+    require('util').log('Timestamped message.');
 
 
 ### util.inspect(object, showHidden=false, depth=2)