Skip to content

Commit 00d641e

Browse files
committed
document namespace problem with new tags
opens #43
1 parent e678d8e commit 00d641e

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

R/shiny2screenshot.R

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,26 @@
99
#' But for quick reference, a screenshot or gif of a shiny app
1010
#' are still helpful for the reader of your documentation.
1111
#'
12+
#' @section Usage in Packages:
13+
#' If you want to use these tags in your own packages,
14+
#' you need to import the *crow* namespace,
15+
#' to let roxygen2 find these new tags.
16+
#'
17+
#' Place this somewhere in your `R/` source:
18+
#'
19+
#' ```
20+
#' #' @import crow
21+
#' ```
22+
#'
23+
#' Without this, you may receive an error message like this:
24+
#'
25+
#' ```
26+
#' ... @crowInsertSnaps is not a known tag.
27+
#' ```
28+
#'
29+
#' This is a workaround until a proper solution can be found
30+
#' in []
31+
#'
1232
#' @family screenshot
1333
#'
1434
#' @name tag_shiny

0 commit comments

Comments
 (0)