Nothing
# Docstrings -------------------------------------------------------------------
test_that("base functions don't have docstrings", {
expect_equal(docstring(`[`), NULL)
expect_equal(docstring(mean), NULL)
})
test_that("function return string doesn't have docstring", {
expect_equal(docstring(function() "a"), NULL)
expect_equal(docstring(function() {"a"}), NULL)
})
test_that("first string in function is docstring", {
expect_equal(docstring(function() {"a"; 1}), "a")
})
test_that("trim_docstring handles indentation correctly", {
expect_equal(trim_docstring("a\n b\n c"), "a\nb\nc")
expect_equal(trim_docstring("a\nb\nc"), "a\nb\nc")
expect_equal(trim_docstring("a\n b\n c"), "a\nb\n c")
expect_equal(trim_docstring(" a\n b\n c"), "a\nb\n c")
})
# Method documentation ---------------------------------------------------------
env <- pkg_env()
A1 <- setRefClass("A1", methods = list(
f = function() {
"This function has a docstring"
1
},
g = function() {
"This function doesn't"
}
), where = env)
B1 <- setRefClass("B1", contains = "A1", methods = list(
f1 = function() {
"This function has a docstring"
1
},
g1 = function() {
"This function doesn't"
}
), where = env)
classA <- getClass("A1", where = env)
classB <- getClass("B1", where = env)
test_that("rc_methods only lists methods belong to class (not parents)", {
expect_equal(length(rc_methods(classA)), 2)
expect_equal(length(rc_methods(classB)), 2)
})
test_that("RC methods included included in own section", {
out <- roc_proc_text(rd_roclet(), "
#' Class ABC
setRefClass('ABC', methods = list(
f = function() {
'This function has a docstring'
1
}
))
")[[1]]
methods <- out$get_value("rcmethods")
expect_equal(names(methods), "f()")
expect_match(methods[[1]], "This function has a docstring")
})
removeClass("B1", where = env)
removeClass("A1", where = env)
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.