From 00d641eaea609e8335dcfb835c242f4596d47a0b Mon Sep 17 00:00:00 2001 From: Maximilian Held Date: Wed, 20 Nov 2024 20:17:12 +0100 Subject: [PATCH] document namespace problem with new tags opens #43 --- R/shiny2screenshot.R | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/R/shiny2screenshot.R b/R/shiny2screenshot.R index 847e2e1..dd89450 100644 --- a/R/shiny2screenshot.R +++ b/R/shiny2screenshot.R @@ -9,6 +9,26 @@ #' But for quick reference, a screenshot or gif of a shiny app #' are still helpful for the reader of your documentation. #' +#' @section Usage in Packages: +#' If you want to use these tags in your own packages, +#' you need to import the *crow* namespace, +#' to let roxygen2 find these new tags. +#' +#' Place this somewhere in your `R/` source: +#' +#' ``` +#' #' @import crow +#' ``` +#' +#' Without this, you may receive an error message like this: +#' +#' ``` +#' ... @crowInsertSnaps is not a known tag. +#' ``` +#' +#' This is a workaround until a proper solution can be found +#' in [] +#' #' @family screenshot #' #' @name tag_shiny