diff options
| author | Trevor Norris <trev.norris@gmail.com> | 2014-09-24 15:41:31 -0700 |
|---|---|---|
| committer | Trevor Norris <trev.norris@gmail.com> | 2014-09-25 11:26:15 -0700 |
| commit | 51b6b6844e9156ab84ae9d0f4592e09f994060b2 (patch) | |
| tree | 669ce8b9f1d556ab2b190268908e88107480d301 /doc/api/https.markdown | |
| parent | 8e4fc88c797857c55c84558708fa7e72bb7e4eca (diff) | |
| download | node-51b6b6844e9156ab84ae9d0f4592e09f994060b2.tar.gz | |
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>
Diffstat (limited to 'doc/api/https.markdown')
| -rw-r--r-- | doc/api/https.markdown | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/https.markdown b/doc/api/https.markdown index 9371db0a8..e95097ca5 100644 --- a/doc/api/https.markdown +++ b/doc/api/https.markdown @@ -18,7 +18,7 @@ See [http.Server#setTimeout()][]. See [http.Server#timeout][]. -## https.createServer(options, [requestListener]) +## https.createServer(options[, requestListener]) Returns a new HTTPS web server object. The `options` is similar to [tls.createServer()][]. The `requestListener` is a function which is @@ -55,9 +55,9 @@ Or }).listen(8000); -### server.listen(port, [host], [backlog], [callback]) -### server.listen(path, [callback]) -### server.listen(handle, [callback]) +### server.listen(port[, host]\[, backlog]\[, callback]) +### server.listen(path[, callback]) +### server.listen(handle[, callback]) See [http.listen()][] for details. |