From 3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Tue, 1 May 2018 17:11:32 -0700 Subject: Markup fixes, ensuring links are colored properly. It turns out that when creating cross references, we need to make any text styling (generally literal characters) outside of the link, to avoid having the styling override the link color. (We prefer to have links colored for ease of use.) While here a few other markup, and actual content, errors were fixed. --- docs/man/nng_http_conn_write.3http.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/man/nng_http_conn_write.3http.adoc') diff --git a/docs/man/nng_http_conn_write.3http.adoc b/docs/man/nng_http_conn_write.3http.adoc index d4f65cac..24daa0b7 100644 --- a/docs/man/nng_http_conn_write.3http.adoc +++ b/docs/man/nng_http_conn_write.3http.adoc @@ -29,19 +29,19 @@ The `nng_http_conn_write()` function starts an asynchronous write to the HTTP connection _conn_ from the scatter/gather vector located in the asynchronous I/O structure _aio_. -NOTE: The <> function must have been +NOTE: The `<>` function must have been called first, to set the scatter/gather vector for _aio_. This function returns immediately, with no return value. Completion of the operation is signaled via the _aio_, and the final -result may be obtained via <>. +result may be obtained via `<>`. That result will either be zero or an error code. The I/O operation completes as soon as at least one byte has been written, or an error has occurred. Therefore, the number of bytes written may be less than requested. The actual number of bytes written can be determined with -<>. +`<>`. TIP: This function is intended to facilitate uses cases that involve changing the protocol from HTTP, such as WebSocket. -- cgit v1.2.3-70-g09d2