Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

small change to documentation for as_api_object #85

Merged
merged 2 commits into from
Apr 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions R/as.R
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
#' Convert to a rapid-style object
#'
#' Convert a named list into an object with a rapid-style class.
#' Convert an object into an object with a rapid-style class.
#'
#' @inheritParams rlang::args_dots_empty
#' @inheritParams rlang::args_error_context
#' @param x The object to coerce. Must be empty or have names corresponding to
#' the parameter of the `target_class`, or names that can be coerced to those
#' names via [snakecase::to_snake_case()]. Extra names are ignored.
#' @param x The object to coerce. Must be empty, or be a named list or character
#' vector having names corresponding to the parameter of the `target_class`,
#' or names that can be coerced to those names via
#' [snakecase::to_snake_case()]. Extra names are ignored.
#' @param target_class The S7 class to which the object should be converted.
#' @param alternate_names Character vector (optional). An optional named
#' character vector, where the names are the names as they might appear in
Expand Down
9 changes: 5 additions & 4 deletions man/as_api_object.Rd

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