Aio documentation cleanups

Author: shikokuchuo

NEWS.md

@@ -2,14 +2,14 @@
 
 #### New Features
 
-* Implemented full async I/O capabilities allowing `send_aio()` and `recv_aio()` to return Aio objects, for which the results may be called using `aio_call()`.
+* Implements full async I/O capabilities - `send_aio()` and `recv_aio()` now return Aio objects, for which the results may be called using `aio_call()`.
 * New `ctx_rep()` and `ctx_req()` functions implement the full logic of an RPC server/client. Designed to be run in separate processes, the server will await data and apply an arbitrary function before returning a result, whilst the client will send data to the server and await a response.
 * New `ncurl()` minimalistic http(s) client.
-* Allow setting the environment variable 'NANONEXT_TLS' prior to package installation to enable TLS where the system NNG library has been built with TLS support (using Mbed TLS).
+* Allows setting the environment variable 'NANONEXT_TLS' prior to package installation to enable TLS where the system NNG library has been built with TLS support (using Mbed TLS).
 
 #### Updates
 
-* All send and receive functions, e.g. `send()`/`recv()`, gain a revamped 'mode' argument. This now permits the choice of whether to use R serialization, consolidating the functionality of the '_vec' series of functions.
+* All send and receive functions, e.g. `send()`/`recv()`, gain a revised 'mode' argument. This now permits the choice of whether to use R serialization, consolidating the functionality of the '_vec' series of functions.
 * Functions 'send_vec' and 'recv_vec' are deprecated and will be removed in a future release.
 
 # nanonext 0.1.0

R/sendrecv.R

@@ -69,10 +69,10 @@ send <- function(socket,
 #'
 #' aio <- send_aio(pub, data.frame(a = 1, b = 2), timeout = 100)
 #' aio
-#' aio_call(aio)
+#' aio_call(aio)$result
 #'
 #' aio <- send_aio(pub, "message 1", mode = "raw", timeout = 100)
-#' aio_call(aio)
+#' aio_call(aio)$result
 #'
 #' close(pub)
 #'
@@ -225,13 +225,17 @@ recv_aio <- function(socket,
 #'
 #' @param aio An Aio (object of class 'sendAio' or 'recvAio').
 #'
-#' @return For a 'sendAio', zero on success. For a 'recvAio', either a named list
-#'     of 2 elements: 'raw' containing the received raw vector and 'data' containing
-#'     the converted R object, or else just the converted R object depending on
-#'     the parameters set.
+#' @return The original Aio object (invisibly).
 #'
-#' @details For a 'recvAio', in case of an error in unserialisation or data
-#'     conversion, the received raw vector will be saved in $raw to allow the
+#' @details For a 'sendAio', the send result will be attached to the Aio in
+#'     \code{$result}. This will be zero on success.
+#'
+#'     For a 'recvAio', the received raw vector will be attached in \code{$raw}
+#'     (unless 'keep.raw' was set to FALSE when receiving), and the converted R
+#'     object in \code{$data}.
+#'
+#'     For a 'recvAio', in case of an error in unserialisation or data conversion,
+#'     the received raw vector will always be saved in \code{$raw} to allow the
 #'     data to be recovered.
 #'
 #' @examples