Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2019-10-24 07:28:42 +0300
committerRich Trott <rtrott@gmail.com>2019-10-26 18:39:41 +0300
commit10040500da6af33b602e35c3f3bbe28cf76c4c4a (patch)
tree69c2af94709de9ef7022c41423c0f618eb0d5e0a /doc/api/dgram.md
parent6858c7e3e7c30986d68a683d3d5e4ede4c0b529f (diff)
doc: remove dashes
The use of dashes -- in general, but especially in our docs -- can be problematic. It is used inconsistently and there is always another form of punctuation that is as good or better for the situation. In an effort to reduce the number of variations we use to display the same types of information, remove the various uses of dashes from the documentation. PR-URL: https://github.com/nodejs/node/pull/30101 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/dgram.md')
-rw-r--r--doc/api/dgram.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/dgram.md b/doc/api/dgram.md
index 894f64f36e1..aea51ad711c 100644
--- a/doc/api/dgram.md
+++ b/doc/api/dgram.md
@@ -706,8 +706,8 @@ changes:
* `ipv6Only` {boolean} Setting `ipv6Only` to `true` will
disable dual-stack support, i.e., binding to address `::` won't make
`0.0.0.0` be bound. **Default:** `false`.
- * `recvBufferSize` {number} - Sets the `SO_RCVBUF` socket value.
- * `sendBufferSize` {number} - Sets the `SO_SNDBUF` socket value.
+ * `recvBufferSize` {number} Sets the `SO_RCVBUF` socket value.
+ * `sendBufferSize` {number} Sets the `SO_SNDBUF` socket value.
* `lookup` {Function} Custom lookup function. **Default:** [`dns.lookup()`][].
* `callback` {Function} Attached as a listener for `'message'` events. Optional.
* Returns: {dgram.Socket}
@@ -725,8 +725,8 @@ and port can be retrieved using [`socket.address().address`][] and
added: v0.1.99
-->
-* `type` {string} - Either `'udp4'` or `'udp6'`.
-* `callback` {Function} - Attached as a listener to `'message'` events.
+* `type` {string} Either `'udp4'` or `'udp6'`.
+* `callback` {Function} Attached as a listener to `'message'` events.
* Returns: {dgram.Socket}
Creates a `dgram.Socket` object of the specified `type`.