Some optional param comments in doc are non-standard
- Version: master 33c27f8f
- Platform: Darwin firedfox-mbp.local 15.4.0 Darwin Kernel Version 15.4.0: Fri Feb 26 22:08:05 PST 2016; root:xnu-3248.40.184~3/RELEASE_X86_64 x86_64
- Subsystem: doc
Some optional params in the doc are like:
methodName([param0, ][param1])
or methodName([param0[, param1]])
Such as:
### socket.send(msg, [offset, length,] port, address[, callback])
## fs.writeSync(fd, data[, position[, encoding]])
These styles prevent json.js to tell whether they are optional.
The correct format is: methodName([param0][, param1])
Such as:
### socket.send(msg[, offset][, length], port, address[, callback])
## fs.writeSync(fd, data[, position][, encoding])
I'll make a PR to fix it.