Skip to content

Commit

Permalink
add pkg level doc witih _PACKAGE fix #263
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Feb 4, 2024
1 parent 35b9da2 commit ef700e5
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 66 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ Suggests:
X-schema.org-applicationCategory: Web
X-schema.org-keywords: http, https, API, web-services, curl, mock, mocking, http-mocking, testing, testing-tools, tdd
X-schema.org-isPartOf: https://ropensci.org
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
19 changes: 6 additions & 13 deletions R/vcr-package.R
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
#' vcr: Record HTTP Calls to Disk
#'
#' \pkg{vcr} records test suite 'HTTP' requests and replay them during
#' future runs.
#'
#' Check out the [http testing book](https://books.ropensci.org/http-testing/)
#' for a lot more documentation on `vcr`, `webmockr`, and `crul`
#'
#' @section Backstory:
#' A Ruby gem of the same name (`VCR`, <https://github.com/vcr/vcr>) was
#' created many years ago and is the original. Ports in many languages
Expand All @@ -29,7 +21,11 @@
#'
#' @section Request matching:
#' See [request-matching] for help on the many request matching options.
#'
#'
#' @keywords internal
"_PACKAGE"

## usethis namespace: start
#' @importFrom R6 R6Class
#' @importFrom utils getParseData
#' @importFrom yaml yaml.load yaml.load_file as.yaml
Expand All @@ -38,10 +34,7 @@
#' @importFrom crul HttpClient mock
#' @importFrom httr http_status content
#' @importFrom webmockr pluck_body
#' @author Scott Chamberlain
#' @docType package
#' @aliases vcr-package
#' @name vcr
## usethis namespace: end
NULL

#' An HTTP request as prepared by the \pkg{crul} package
Expand Down
69 changes: 69 additions & 0 deletions man/vcr-package.Rd

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

52 changes: 0 additions & 52 deletions man/vcr.Rd

This file was deleted.

0 comments on commit ef700e5

Please sign in to comment.