Skip to content

Commit

Permalink
document namespace problem with new tags
Browse files Browse the repository at this point in the history
opens #43
  • Loading branch information
maxheld83 committed Nov 20, 2024
1 parent e678d8e commit 00d641e
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions R/shiny2screenshot.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 00d641e

Please sign in to comment.