Merge pull request #688 from DyfanJones/main

address cran note around itemize

Author: DyfanJones

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.

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()

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.