tests/testthat/_snaps/rd-examples.md

In r-lib/roxygen2: In-Line Documentation for R

@examples and @example interleave

\examples{
example <- 'example1'
a <- 2
example <- 'example2'
}

@example gives warning if used instead of @examples

Code
  out <- roc_proc_text(rd_roclet(), block)[[1]]
Message
  x <text>:4: @example must be a single line.
  i Do you want @examples?

warns if path doesn't exist

Code
  . <- roc_proc_text(rd_roclet(), block)
Message
  x <text>:4: @example './this-path-doesnt-exist.R' doesn't exist.

@examplesIf

\examples{
\dontshow{if (foo::bar()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
maybe-run-this-code
\dontshow{\}) # examplesIf}
\dontshow{if (foobar()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
and-this
\dontshow{\}) # examplesIf}
}

@examplesIf warns about unparseable condition

Code
  . <- roc_proc_text(rd_roclet(), block)
Message
  x <text>:4: @examplesIf condition failed to parse.
  Caused by error in `parse()`:
  ! <text>:2:0: unexpected end of input
  1: 1 +
     ^

r-lib/roxygen2 documentation built on April 21, 2024, 4:36 a.m.