Skip to content

Commit 6338ce1

Browse files
committed
documentation changes for @NAMEs param - move to qenv-consrtuctor
1 parent 9304459 commit 6338ce1

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

R/qenv-constructor.R

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ qenv <- function() {
3333
#' (`character(1)` or `language`) code to evaluate. Accepts and stores comments also.
3434
#' @param env `r badge("deprecated")` (`environment`)
3535
#' Environment being a result of the `code` evaluation.
36+
#' @param names (`character`) for `x[names]`, names of objects included in `qenv` to subset. Names not present in `qenv`
37+
#' are skipped. For `get_code` `r lifecycle::badge("experimental")` vector of object names to return the code for.
38+
#' For more details see the "Extracting dataset-specific code" section.
3639
#'
3740
#' @examples
3841
#' # create qenv with data and code (deprecated)

R/qenv-extract.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
#' @section Subsetting:
33
#' `x[names]` subsets objects in `qenv` environment and limit the code to the necessary needed to build limited objects.
44
#'
5-
#' @param names (`character`) names of objects included in `qenv` to subset
65
#' @param x (`qenv`)
76
#'
87
#' @examples

R/qenv-get_code.R

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,11 @@
55
#'
66
#' @param object (`qenv`)
77
#' @param deparse (`logical(1)`) flag specifying whether to return code as `character` or `expression`.
8-
#' @param names `r lifecycle::badge("experimental")` (`character`) vector of object names to return the code for.
9-
#' For more details see the "Extracting dataset-specific code" section.
108
#' @param ... see `Details`
119
#'
1210
#'
1311
#' @section Extracting dataset-specific code:
14-
#' When `names` is specified, the code returned will be limited to the lines needed to _create_
12+
#' When `names` for `get_code` is specified, the code returned will be limited to the lines needed to _create_
1513
#' the requested objects. The code stored in the `@code` slot is analyzed statically to determine
1614
#' which lines the objects of interest depend upon. The analysis works well when objects are created
1715
#' with standard infix assignment operators (see `?assignOps`) but it can fail in some situations.

man/qenv.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)