Skip to content

Commit 2971a17

Browse files
committed
update documentation for qenv slots
1 parent 894f819 commit 2971a17

File tree

3 files changed

+24
-14
lines changed

3 files changed

+24
-14
lines changed

R/qenv-class.R

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,18 @@
33
#' Reproducible class with environment and code.
44
#' @name qenv-class
55
#' @rdname qenv-class
6-
#' @slot code (`character`) representing code necessary to reproduce the environment
6+
#' @slot code (`list` of `character`) representing code necessary to reproduce the environment.
7+
#' Read more in Code section.
78
#' @slot env (`environment`) environment which content was generated by the evaluation
89
#' of the `code` slot.
9-
#' @slot id (`integer`) random identifier of the code element to make sure uniqueness
10-
#' when joining.
11-
#' @slot warnings (`character`) the warnings output when evaluating the code
12-
#' @slot messages (`character`) the messages output when evaluating the code
10+
#'
11+
#' @section Code:
12+
#'
13+
#' Each code element is a character representing one call. Each element has possible attributes:
14+
#' - warnings (`character`) the warnings output when evaluating the code element
15+
#' - messages (`character`) the messages output when evaluating the code element
16+
#' - id (`integer`) random identifier of the code element to make sure uniqueness when joining.
17+
#'
1318
#' @keywords internal
1419
#' @exportClass qenv
1520
setClass(

man/qenv-class.Rd

Lines changed: 11 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/qenv.Rd

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

0 commit comments

Comments
 (0)