Skip to content

Commit

Permalink
catch more items in Rd files
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Oct 24, 2023
1 parent 7540e0d commit efa322f
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 64 deletions.
24 changes: 12 additions & 12 deletions R/ncurl.R
Original file line number Diff line number Diff line change
Expand Up @@ -96,16 +96,16 @@ ncurl <- function(url,
#' @return An 'ncurlAio' (object of class 'ncurlAio' and 'recvAio') (invisibly).
#' The following elements may be accessed:
#' \itemize{
#' \item{\code{$status}} {- integer HTTP repsonse status code (200 - OK).
#' Use \code{\link{status_code}} for a translation of the meaning.}
#' \item{\code{$headers}} {- named list of response headers supplied in
#' \item \code{$status} - integer HTTP repsonse status code (200 - OK).
#' Use \code{\link{status_code}} for a translation of the meaning.
#' \item \code{$headers} - named list of response headers supplied in
#' 'response', or NULL otherwise. If the status code is within the 300
#' range, i.e. a redirect, the response header 'Location' is automatically
#' appended to return the redirect address.}
#' \item{\code{$data}} {- the response body, as a character string if
#' appended to return the redirect address.
#' \item \code{$data} - the response body, as a character string if
#' 'convert' = TRUE (may be further parsed as html, json, xml etc. as
#' required), or a raw byte vector if FALSE (use \code{\link{writeBin}} to
#' save as a file).}
#' save as a file).
#' }
#'
#' @seealso \code{\link{ncurl_session}} for persistent connections.
Expand Down Expand Up @@ -167,16 +167,16 @@ ncurl_session <- function(url,
#'
#' @return For \code{transact}: a named list of 3 elements:
#' \itemize{
#' \item{\code{$status}} {- integer HTTP repsonse status code (200 - OK).
#' Use \code{\link{status_code}} for a translation of the meaning.}
#' \item{\code{$headers}} {- named list of response headers (if specified in
#' \item \code{$status} - integer HTTP repsonse status code (200 - OK).
#' Use \code{\link{status_code}} for a translation of the meaning.
#' \item \code{$headers} - named list of response headers (if specified in
#' the session), or NULL otherwise. If the status code is within the 300
#' range, i.e. a redirect, the response header 'Location' is automatically
#' appended to return the redirect address.}
#' \item{\code{$data}} {- the response body as a character string (if
#' appended to return the redirect address.
#' \item \code{$data} - the response body as a character string (if
#' 'convert = TRUE' was specified for the session), which may be further
#' parsed as html, json, xml etc. as required, or else a raw byte vector,
#' which may be saved as a file using \code{\link{writeBin}}.}
#' which may be saved as a file using \code{\link{writeBin}}.
#' }
#'
#' @rdname ncurl_session
Expand Down
40 changes: 20 additions & 20 deletions R/stats.R
Original file line number Diff line number Diff line change
Expand Up @@ -39,38 +39,38 @@
#'
#' The following stats may be requested for a Socket:
#' \itemize{
#' \item{'id'} {- numeric id of the socket.}
#' \item{'name'} {- character socket name.}
#' \item{'protocol'} {- character protocol type e.g. 'bus'.}
#' \item{'pipes'} {- numeric number of pipes (active connections).}
#' \item{'dialers'} {- numeric number of listeners attached to the socket.}
#' \item{'listeners'} {- numeric number of dialers attached to the socket.}
#' \item 'id' - numeric id of the socket.
#' \item 'name' - character socket name.
#' \item 'protocol' - character protocol type e.g. 'bus'.
#' \item 'pipes' - numeric number of pipes (active connections).
#' \item 'dialers' - numeric number of listeners attached to the socket.
#' \item 'listeners' - numeric number of dialers attached to the socket.
#' }
#'
#' The following stats may be requested for a Listener / Dialer:
#' \itemize{
#' \item{'id'} {- numeric id of the listener / dialer.}
#' \item{'socket'} {- numeric id of the socket of the listener / dialer.}
#' \item{'url'} {- character URL address.}
#' \item{'pipes'} {- numeric number of pipes (active connections).}
#' \item 'id' - numeric id of the listener / dialer.
#' \item 'socket' - numeric id of the socket of the listener / dialer.
#' \item 'url' - character URL address.
#' \item 'pipes' - numeric number of pipes (active connections).
#' }
#'
#' The following additional stats may be requested for a Listener:
#' \itemize{
#' \item{'accept'} {- numeric total number of connection attempts, whether
#' successful or not.}
#' \item{'reject'} {- numeric total number of rejected connection attempts
#' e.g. due to incompatible protocols.}
#' \item 'accept' - numeric total number of connection attempts, whether
#' successful or not.
#' \item 'reject' - numeric total number of rejected connection attempts
#' e.g. due to incompatible protocols.
#' }
#'
#' The following additional stats may be requested for a Dialer:
#' \itemize{
#' \item{'connect'} {- numeric total number of connection attempts, whether
#' successful or not.}
#' \item{'reject'} {- numeric total number of rejected connection attempts
#' e.g. due to incompatible protocols.}
#' \item{'refused'} {- numeric total number of refused connections e.g. when
#' starting synchronously with no listener on the other side.}
#' \item 'connect' - numeric total number of connection attempts, whether
#' successful or not.
#' \item 'reject' - numeric total number of rejected connection attempts
#' e.g. due to incompatible protocols.
#' \item 'refused' - numeric total number of refused connections e.g. when
#' starting synchronously with no listener on the other side.
#' }
#'
#' @examples
Expand Down
12 changes: 6 additions & 6 deletions man/ncurl_aio.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions man/ncurl_session.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 20 additions & 20 deletions man/stat.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit efa322f

Please sign in to comment.