Skip to content

Commit

Permalink
doc: remove optional parameter from markdown anchor link
Browse files Browse the repository at this point in the history
Fix up a few instances so that lines don't xceed 80 characters.

PR-URL: #32671
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
  • Loading branch information
Trott committed Apr 7, 2020
1 parent 8aa7ef7 commit c849f2d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/api/net.md
Expand Up @@ -589,7 +589,7 @@ Possible signatures:
* [`socket.connect(options[, connectListener])`][`socket.connect(options)`]
* [`socket.connect(path[, connectListener])`][`socket.connect(path)`]
for [IPC][] connections.
* [`socket.connect(port[, host][, connectListener])`][`socket.connect(port, host)`]
* [`socket.connect(port[, host][, connectListener])`][`socket.connect(port)`]
for TCP connections.
* Returns: {net.Socket} The socket itself.

Expand Down Expand Up @@ -1098,21 +1098,21 @@ added: v0.1.90
-->

* `port` {number} Port the socket should connect to. Will be passed to
[`socket.connect(port[, host][, connectListener])`][`socket.connect(port, host)`].
[`socket.connect(port[, host][, connectListener])`][`socket.connect(port)`].
* `host` {string} Host the socket should connect to. Will be passed to
[`socket.connect(port[, host][, connectListener])`][`socket.connect(port, host)`].
[`socket.connect(port[, host][, connectListener])`][`socket.connect(port)`].
**Default:** `'localhost'`.
* `connectListener` {Function} Common parameter of the
[`net.createConnection()`][] functions, an "once" listener for the
`'connect'` event on the initiating socket. Will be passed to
[`socket.connect(port[, host][, connectListener])`][`socket.connect(port, host)`].
[`socket.connect(port[, host][, connectListener])`][`socket.connect(port)`].
* Returns: {net.Socket} The newly created socket used to start the connection.

Initiates a TCP connection.

This function creates a new [`net.Socket`][] with all options set to default,
immediately initiates connection with
[`socket.connect(port[, host][, connectListener])`][`socket.connect(port, host)`],
[`socket.connect(port[, host][, connectListener])`][`socket.connect(port)`],
then returns the `net.Socket` that starts the connection.

## `net.createServer([options][, connectionListener])`
Expand Down Expand Up @@ -1259,7 +1259,7 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`.
[`socket.connect()`]: #net_socket_connect
[`socket.connect(options)`]: #net_socket_connect_options_connectlistener
[`socket.connect(path)`]: #net_socket_connect_path_connectlistener
[`socket.connect(port, host)`]: #net_socket_connect_port_host_connectlistener
[`socket.connect(port)`]: #net_socket_connect_port_host_connectlistener
[`socket.connecting`]: #net_socket_connecting
[`socket.destroy()`]: #net_socket_destroy_exception
[`socket.end()`]: #net_socket_end_data_encoding_callback
Expand Down

0 comments on commit c849f2d

Please sign in to comment.