chore: fix test and add docs

insightsengineering · Dec 13, 2024 · 94e355e · 94e355e
1 parent 1df1619
commit 94e355e
Show file tree

Hide file tree

Showing 3 changed files with 124 additions and 1 deletion.
diff --git a/R/HTMLBlock.R b/R/HTMLBlock.R
@@ -1,3 +1,11 @@
+#' @title `HTMLBlock`
+#' @docType class
+#' @description
+#' Specialized `FileBlock` for managing HTML content in reports.
+#' It's designed to handle various HTML content, and render the report as HTML,
+#' however htmlwidget objects can also be rendered to static document-ready format.
+#'
+#' @keywords internal
 HTMLBlock <- R6::R6Class( # nolint: object_name_linter.
   classname = "HTMLBlock",
   inherit = FileBlock,

diff --git a/man/HTMLBlock.Rd b/man/HTMLBlock.Rd
diff --git a/tests/testthat/test-Renderer.R b/tests/testthat/test-Renderer.R
@@ -24,7 +24,7 @@ testthat::test_that("renderRmd asserts the argument is a list of TextBlocks/Pict
   renderer <- Renderer$new()
   testthat::expect_error(
     renderer$renderRmd(append(blocks, "STH")),
-    regexp = "May only contain the following types: \\{TextBlock,PictureBlock,NewpageBlock,TableBlock,RcodeBlock\\}"
+    regexp = "May only contain the following types: \\{TextBlock,PictureBlock,NewpageBlock,TableBlock,RcodeBlock,HTMLBlock\\}" # nolint line_length
   )
 })