diff --git a/make.paws/inst/templates/service_parameter_helper.R b/make.paws/inst/templates/service_parameter_helper.R index 373111773..1440fa005 100644 --- a/make.paws/inst/templates/service_parameter_helper.R +++ b/make.paws/inst/templates/service_parameter_helper.R @@ -9,19 +9,19 @@ #' #' @param credentials \code{credentials()} or \code{list} is same format. #' \itemize{ -#' \item{\strong{creds}:} {\code{creds()} or \code{list} in same format. +#' \item{\strong{creds}: \code{creds()} or \code{list} in same format. #' \itemize{ -#' \item{\strong{access_key_id}:} {AWS access key ID} -#' \item{\strong{secret_access_key}:} {AWS secret access key} -#' \item{\strong{session_token}:} {AWS temporary session token} -#' \item{\strong{access_token}:} {The token issued by the \code{CreateToken} API call. For more information, see +#' \item{\strong{access_key_id}: AWS access key ID} +#' \item{\strong{secret_access_key}: AWS secret access key} +#' \item{\strong{session_token}: AWS temporary session token} +#' \item{\strong{access_token}: The token issued by the \code{CreateToken} API call. For more information, see #' \href{https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html}{CreateToken} #' in the `IAM Identity Center OIDC API Reference Guide`.} -#' \item{\strong{expiration}:} {The date and time when the temporary credentials expire. +#' \item{\strong{expiration}: The date and time when the temporary credentials expire. #' `expiration` must be a `POSIXct` date-time or able to be compared with them.} #' }} -#' \item{\strong{profile}:} {The name of a profile to use. If not given, then the default profile is used.} -#' \item{\strong{anonymous}:} {Set anonymous credentials.} +#' \item{\strong{profile}: The name of a profile to use. If not given, then the default profile is used.} +#' \item{\strong{anonymous}: Set anonymous credentials.} #' } #' @param endpoint The complete URL to use for the constructed client. #' @param region The AWS Region used in instantiating the client. @@ -37,13 +37,13 @@ #' Note that the default version is Signature Version 4. #' @param creds \code{creds()} or \code{list} in same format. #' \itemize{ -#' \item{\strong{access_key_id}:} {AWS access key ID} -#' \item{\strong{secret_access_key}:} {AWS secret access key} -#' \item{\strong{session_token}:} {AWS temporary session token} -#' \item{\strong{access_token}:} {The token issued by the \code{CreateToken} API call. For more information, see +#' \item{\strong{access_key_id}: AWS access key ID} +#' \item{\strong{secret_access_key}: AWS secret access key} +#' \item{\strong{session_token}: AWS temporary session token} +#' \item{\strong{access_token}: The token issued by the \code{CreateToken} API call. For more information, see #' \href{https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html}{CreateToken} #' in the `IAM Identity Center OIDC API Reference Guide`.} -#' \item{\strong{expiration}:} {The date and time when the temporary credentials expire. +#' \item{\strong{expiration}: The date and time when the temporary credentials expire. #' `expiration` must be a `POSIXct` date-time or able to be compared with them.} #' } #' @param profile The name of a profile to use. If not given, then the default profile is used. diff --git a/paws.common/R/logging.R b/paws.common/R/logging.R index 9b6111644..92c74b3b1 100644 --- a/paws.common/R/logging.R +++ b/paws.common/R/logging.R @@ -13,22 +13,18 @@ #' helper function \code{`paws_config_log`} or `R:base` \code{options} function. #' Users are able to change logging levels without calling \code{paws.common} by #' the use of \code{options} e.g. \code{options("paws.log_level" = 2L)}. -#' \itemize{ -#' \item{paws.log_level} {integer: The minimum log level that should be tracked} -#' \item{paws.log_file} { -#' character: path for logs to populate, default output logs to console. -#' } -#' \item{paws.log_timestamp_fmt} {character: see [format.POSIXct()]} -#' } -#' @param level integer to determine the level logging threshold. -#' \itemize{ -#' \item{4L :} {DEBUG} -#' \item{3L :} {INFO} -#' \item{2L :} {WARNING} -#' \item{1L :} {ERROR} -#' } -#' @param file character path for logs to populate, default output logs to console. -#' @param timestamp_fmt character for timestamp format, see [format.POSIXct()]. +#' * `paws.log_level` (integer): The minimum log level that should be tracked +#' * `paws.log_file` (character): path for logs to populate, default output logs to console. +#' * `paws.log_timestamp_fmt` (character): see [format.POSIXct()] +#' +#' @param level (integer) to determine the level logging threshold. +#' * `4L`: DEBUG +#' * `3L`: INFO +#' * `2L`: WARNING +#' * `1L`: ERROR +#' +#' @param file (character) path for logs to populate, default output logs to console. +#' @param timestamp_fmt (character) for timestamp format, see [format.POSIXct()]. #' @examples #' # log to a file #' temp_file <- tempfile() diff --git a/paws.common/R/service_parameter_helper.R b/paws.common/R/service_parameter_helper.R index dc49741bc..885613d5b 100644 --- a/paws.common/R/service_parameter_helper.R +++ b/paws.common/R/service_parameter_helper.R @@ -9,19 +9,19 @@ #' #' @param credentials \code{credentials()} or \code{list} is same format. #' \itemize{ -#' \item{\strong{creds}:} {\code{creds()} or \code{list} in same format. +#' \item{\strong{creds}: \code{creds()} or \code{list} in same format. #' \itemize{ -#' \item{\strong{access_key_id}:} {AWS access key ID} -#' \item{\strong{secret_access_key}:} {AWS secret access key} -#' \item{\strong{session_token}:} {AWS temporary session token} -#' \item{\strong{access_token}:} {The token issued by the \code{CreateToken} API call. For more information, see +#' \item{\strong{access_key_id}: AWS access key ID} +#' \item{\strong{secret_access_key}: AWS secret access key} +#' \item{\strong{session_token}: AWS temporary session token} +#' \item{\strong{access_token}: The token issued by the \code{CreateToken} API call. For more information, see #' \href{https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html}{CreateToken} #' in the `IAM Identity Center OIDC API Reference Guide`.} -#' \item{\strong{expiration}:} {The date and time when the temporary credentials expire. +#' \item{\strong{expiration}: The date and time when the temporary credentials expire. #' `expiration` must be a `POSIXct` date-time or able to be compared with them.} #' }} -#' \item{\strong{profile}:} {The name of a profile to use. If not given, then the default profile is used.} -#' \item{\strong{anonymous}:} {Set anonymous credentials.} +#' \item{\strong{profile}: The name of a profile to use. If not given, then the default profile is used.} +#' \item{\strong{anonymous}: Set anonymous credentials.} #' } #' @param endpoint The complete URL to use for the constructed client. #' @param region The AWS Region used in instantiating the client. @@ -37,13 +37,13 @@ #' Note that the default version is Signature Version 4. #' @param creds \code{creds()} or \code{list} in same format. #' \itemize{ -#' \item{\strong{access_key_id}:} {AWS access key ID} -#' \item{\strong{secret_access_key}:} {AWS secret access key} -#' \item{\strong{session_token}:} {AWS temporary session token} -#' \item{\strong{access_token}:} {The token issued by the \code{CreateToken} API call. For more information, see +#' \item{\strong{access_key_id}: AWS access key ID} +#' \item{\strong{secret_access_key}: AWS secret access key} +#' \item{\strong{session_token}: AWS temporary session token} +#' \item{\strong{access_token}: The token issued by the \code{CreateToken} API call. For more information, see #' \href{https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html}{CreateToken} #' in the `IAM Identity Center OIDC API Reference Guide`.} -#' \item{\strong{expiration}:} {The date and time when the temporary credentials expire. +#' \item{\strong{expiration}: The date and time when the temporary credentials expire. #' `expiration` must be a `POSIXct` date-time or able to be compared with them.} #' } #' @param profile The name of a profile to use. If not given, then the default profile is used. diff --git a/paws.common/man/paws_config_log.Rd b/paws.common/man/paws_config_log.Rd index 06160c551..ee4b34284 100644 --- a/paws.common/man/paws_config_log.Rd +++ b/paws.common/man/paws_config_log.Rd @@ -11,17 +11,17 @@ paws_config_log( ) } \arguments{ -\item{level}{integer to determine the level logging threshold. +\item{level}{(integer) to determine the level logging threshold. \itemize{ -\item{4L :} {DEBUG} -\item{3L :} {INFO} -\item{2L :} {WARNING} -\item{1L :} {ERROR} +\item \code{4L}: DEBUG +\item \code{3L}: INFO +\item \code{2L}: WARNING +\item \code{1L}: ERROR }} -\item{file}{character path for logs to populate, default output logs to console.} +\item{file}{(character) path for logs to populate, default output logs to console.} -\item{timestamp_fmt}{character for timestamp format, see \code{\link[=format.POSIXct]{format.POSIXct()}}.} +\item{timestamp_fmt}{(character) for timestamp format, see \code{\link[=format.POSIXct]{format.POSIXct()}}.} } \description{ Ability to configure paws logging system, through the use of paws @@ -29,11 +29,9 @@ helper function \code{`paws_config_log`} or \code{R:base} \code{options} functio Users are able to change logging levels without calling \code{paws.common} by the use of \code{options} e.g. \code{options("paws.log_level" = 2L)}. \itemize{ -\item{paws.log_level} {integer: The minimum log level that should be tracked} -\item{paws.log_file} { -character: path for logs to populate, default output logs to console. -} -\item{paws.log_timestamp_fmt} {character: see \code{\link[=format.POSIXct]{format.POSIXct()}}} +\item \code{paws.log_level} (integer): The minimum log level that should be tracked +\item \code{paws.log_file} (character): path for logs to populate, default output logs to console. +\item \code{paws.log_timestamp_fmt} (character): see \code{\link[=format.POSIXct]{format.POSIXct()}} } } \examples{ diff --git a/paws.common/man/set_service_parameter.Rd b/paws.common/man/set_service_parameter.Rd index c67f6bf8b..95c3b2c55 100644 --- a/paws.common/man/set_service_parameter.Rd +++ b/paws.common/man/set_service_parameter.Rd @@ -39,19 +39,19 @@ creds( \arguments{ \item{credentials}{\code{credentials()} or \code{list} is same format. \itemize{ -\item{\strong{creds}:} {\code{creds()} or \code{list} in same format. +\item{\strong{creds}: \code{creds()} or \code{list} in same format. \itemize{ -\item{\strong{access_key_id}:} {AWS access key ID} -\item{\strong{secret_access_key}:} {AWS secret access key} -\item{\strong{session_token}:} {AWS temporary session token} -\item{\strong{access_token}:} {The token issued by the \code{CreateToken} API call. For more information, see +\item{\strong{access_key_id}: AWS access key ID} +\item{\strong{secret_access_key}: AWS secret access key} +\item{\strong{session_token}: AWS temporary session token} +\item{\strong{access_token}: The token issued by the \code{CreateToken} API call. For more information, see \href{https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html}{CreateToken} in the \verb{IAM Identity Center OIDC API Reference Guide}.} -\item{\strong{expiration}:} {The date and time when the temporary credentials expire. +\item{\strong{expiration}: The date and time when the temporary credentials expire. \code{expiration} must be a \code{POSIXct} date-time or able to be compared with them.} }} -\item{\strong{profile}:} {The name of a profile to use. If not given, then the default profile is used.} -\item{\strong{anonymous}:} {Set anonymous credentials.} +\item{\strong{profile}: The name of a profile to use. If not given, then the default profile is used.} +\item{\strong{anonymous}: Set anonymous credentials.} }} \item{endpoint}{The complete URL to use for the constructed client.} @@ -76,13 +76,13 @@ Note that the default version is Signature Version 4.} \item{creds}{\code{creds()} or \code{list} in same format. \itemize{ -\item{\strong{access_key_id}:} {AWS access key ID} -\item{\strong{secret_access_key}:} {AWS secret access key} -\item{\strong{session_token}:} {AWS temporary session token} -\item{\strong{access_token}:} {The token issued by the \code{CreateToken} API call. For more information, see +\item{\strong{access_key_id}: AWS access key ID} +\item{\strong{secret_access_key}: AWS secret access key} +\item{\strong{session_token}: AWS temporary session token} +\item{\strong{access_token}: The token issued by the \code{CreateToken} API call. For more information, see \href{https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html}{CreateToken} in the \verb{IAM Identity Center OIDC API Reference Guide}.} -\item{\strong{expiration}:} {The date and time when the temporary credentials expire. +\item{\strong{expiration}: The date and time when the temporary credentials expire. \code{expiration} must be a \code{POSIXct} date-time or able to be compared with them.} }}