Skip to content

Commit

Permalink
a few edits to use_cassette()'s docs
Browse files Browse the repository at this point in the history
- make it clearer that wrapping ... in curly braces is not required
- remove outdated message about recording modes being supported in the future
  • Loading branch information
aaronwolen committed Feb 18, 2020
1 parent 893f676 commit 3108f76
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions R/use_cassette.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
#' @export
#' @param name The name of the cassette. vcr will sanitize this to ensure it
#' is a valid file name.
#' @param ... a block of code to evalulate, wrapped in curly braces. required.
#' if you don't pass a code block you'll get a stop message. if you can't pass
#' a code block use instead [insert_cassette()]
#' @param record The record mode. Default: "once". In the future we'll support
#' "once", "all", "none", "new_episodes". See [recording] for more information
#' @param ... a block of code containing one or more requests (required). Use
#' curly braces to encapsulate multi-line code blocks. If you can't pass a code
#' block use [insert_cassette()] instead.
#' @param record The record mode (default: `"once"`). See [recording] for a
#' complete list of the different recording modes.
#' @param match_requests_on List of request matchers
#' to use to determine what recorded HTTP interaction to replay. Defaults to
#' `["method", "uri"]`. The built-in matchers are "method", "uri", "host",
Expand Down

0 comments on commit 3108f76

Please sign in to comment.