document GeomMarquee

r-lib · May 2, 2024 · b5baa2e · b5baa2e
1 parent 32f5c8e
commit b5baa2e
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/R/geom_marquee.R b/R/geom_marquee.R
@@ -72,7 +72,15 @@ geom_marquee <- function(mapping = NULL, data = NULL, stat = "identity",
   )
 }
 
+#' Geom class for geom_marquee
+#'
+#' This environment contains the Geom needed for [geom_marquee()] in the `geom`
+#' variable. It is set up like this to avoid ggplot2 to be a hard dependency of
+#' marquee
+#'
 #' @export
+#'
+#' @keywords internal
 GeomMarquee <- new_environment(list(geom = NULL))
 
 make_marquee_geom <- function() {

diff --git a/man/GeomMarquee.Rd b/man/GeomMarquee.Rd