doc: show links consistently in deprecations
authorSakthipriyan Vairamani <thechargingvolcano@gmail.com>
Wed, 27 Jan 2016 13:49:05 +0000 (19:19 +0530)
committerMyles Borins <mborins@us.ibm.com>
Wed, 2 Mar 2016 22:01:11 +0000 (14:01 -0800)
PR-URL: https://github.com/nodejs/node/pull/4907
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
doc/api/crypto.markdown
doc/api/net.markdown
doc/api/tls.markdown
doc/api/util.markdown

index 0b97e0b..f65ff0f 100644 (file)
@@ -854,7 +854,7 @@ The `key` is the raw key used by the `algorithm` and `iv` is an
 
 ### crypto.createCredentials(details)
 
-    Stability: 0 - Deprecated: Use [`tls.createSecureContext`][] instead.
+    Stability: 0 - Deprecated: Use [`tls.createSecureContext()`][] instead.
 
 The `crypto.createCredentials()` method is a deprecated alias for creating
 and returning a `tls.SecureContext` object. The `crypto.createCredentials()`
@@ -1339,7 +1339,7 @@ See the reference for other recommendations and details.
 [`diffieHellman.setPublicKey()`]: #crypto_diffiehellman_setpublickey_public_key_encoding
 [`EVP_BytesToKey`]: https://www.openssl.org/docs/crypto/EVP_BytesToKey.html
 [`getCurves()`]: #crypto_crypto_getcurves
-[`tls.createSecureContext`]: tls.html#tls_tls_createsecurecontext_details
+[`tls.createSecureContext()`]: tls.html#tls_tls_createsecurecontext_details
 [`Buffer`]: buffer.html
 [buffers]: buffer.html
 [Caveats]: #crypto_support_for_weak_or_compromised_algorithms
index a5f4621..899f5d7 100644 (file)
@@ -71,7 +71,7 @@ was not open when it was closed.
 
 ### server.connections
 
-    Stability: 0 - Deprecated: Use [`server.getConnections`][] instead.
+    Stability: 0 - Deprecated: Use [`server.getConnections()`][] instead.
 
 The number of concurrent connections on the server.
 
@@ -717,7 +717,7 @@ Returns true if input is a version 6 IP address, otherwise returns false.
 [`net.Socket`]: #net_class_net_socket
 [`pause()`]: #net_socket_pause
 [`resume()`]: #net_socket_resume
-[`server.getConnections`]: #net_server_getconnections_callback
+[`server.getConnections()`]: #net_server_getconnections_callback
 [`server.listen(port, \[host\], \[backlog\], \[callback\])`]: #net_server_listen_port_hostname_backlog_callback
 [`socket.connect(options\[, connectListener\])`]: #net_socket_connect_options_connectlistener
 [`socket.connect`]: #net_socket_connect_options_connectlistener
index aadaace..7f19a99 100644 (file)
@@ -159,7 +159,7 @@ is expensive.
 
 ## Class: CryptoStream
 
-    Stability: 0 - Deprecated: Use [tls.TLSSocket][] instead.
+    Stability: 0 - Deprecated: Use [`tls.TLSSocket()`][] instead.
 
 This is an encrypted stream.
 
@@ -917,7 +917,7 @@ console.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]
 [crypto.getCurves()]: crypto.html#crypto_crypto_getcurves
 [tls.createServer]: #tls_tls_createserver_options_secureconnectionlistener
 [tls.createSecurePair]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized_options
-[tls.TLSSocket]: #tls_class_tls_tlssocket
+[`tls.TLSSocket()`]: #tls_class_tls_tlssocket
 [`net.Server`]: net.html#net_class_net_server
 [`net.Socket`]: net.html#net_class_net_socket
 [net.Server.address()]: net.html#net_server_address
index e270276..713bded 100644 (file)
@@ -14,7 +14,7 @@ are unnecessary for Node.js's internal functionality.
 
 ## util.debug(string)
 
-    Stability: 0 - Deprecated: use console.error() instead.
+    Stability: 0 - Deprecated: Use [`console.error()`][] instead.
 
 Deprecated predecessor of `console.error`.
 
@@ -83,7 +83,7 @@ when the deprecated API is used.  Configurable at run-time through the
 
 ## util.error([...])
 
-    Stability: 0 - Deprecated: Use console.error() instead.
+    Stability: 0 - Deprecated: Use [`console.error()`][] instead.
 
 Deprecated predecessor of `console.error`.
 
@@ -286,9 +286,7 @@ util.isBoolean(false)
 
 ## util.isBuffer(object)
 
-    Stability: 0 - Deprecated
-
-Use `Buffer.isBuffer()` instead.
+    Stability: 0 - Deprecated: Use [`Buffer.isBuffer()`][] instead.
 
 Returns `true` if the given "object" is a `Buffer`. `false` otherwise.
 
@@ -538,7 +536,7 @@ Output with timestamp on `stdout`.
 
 ## util.print([...])
 
-    Stability: 0 - Deprecated: Use `console.log` instead.
+    Stability: 0 - Deprecated: Use [`console.log()`][] instead.
 
 Deprecated predecessor of `console.log`.
 
@@ -550,7 +548,7 @@ Deprecated predecessor of `stream.pipe()`.
 
 ## util.puts([...])
 
-    Stability: 0 - Deprecated: Use console.log() instead.
+    Stability: 0 - Deprecated: Use [`console.log()`][] instead.
 
 Deprecated predecessor of `console.log`.
 
@@ -559,3 +557,6 @@ Deprecated predecessor of `console.log`.
 [Customizing `util.inspect` colors]: #util_customizing_util_inspect_colors
 [here]: #util_customizing_util_inspect_colors
 [`Error`]: errors.html#errors_class_error
+[`console.log()`]: console.html#console_console_log_data
+[`console.error()`]: console.html#console_console_error_data
+[`Buffer.isBuffer()`]: buffer.html#buffer_class_method_buffer_isbuffer_obj