doc: fix brackets for optional parameters
authorTrevor Norris <trev.norris@gmail.com>
Wed, 24 Sep 2014 22:41:31 +0000 (15:41 -0700)
committerTrevor Norris <trev.norris@gmail.com>
Thu, 25 Sep 2014 18:26:15 +0000 (11:26 -0700)
commit51b6b6844e9156ab84ae9d0f4592e09f994060b2
tree669ce8b9f1d556ab2b190268908e88107480d301
parent8e4fc88c797857c55c84558708fa7e72bb7e4eca
doc: fix brackets for optional parameters

Documentation incorrectly used bracket notation for optional parameters.
This caused inconsistencies in usage because of examples like the
following:

    fs.write(fd, data[, position[, encoding]], callback)

This simply fixes all uses of bracket notation in documentation.

Signed-off-by: Trevor Norris <trev.norris@gmail.com>
Reviewed-by: Fedor Indutny <fedor@indutny.com>
24 files changed:
doc/api/assert.markdown
doc/api/buffer.markdown
doc/api/child_process.markdown
doc/api/cluster.markdown
doc/api/console.markdown
doc/api/crypto.markdown
doc/api/dgram.markdown
doc/api/dns.markdown
doc/api/events.markdown
doc/api/fs.markdown
doc/api/http.markdown
doc/api/https.markdown
doc/api/net.markdown
doc/api/path.markdown
doc/api/process.markdown
doc/api/querystring.markdown
doc/api/readline.markdown
doc/api/stream.markdown
doc/api/timers.markdown
doc/api/tls.markdown
doc/api/url.markdown
doc/api/util.markdown
doc/api/vm.markdown
doc/api/zlib.markdown