Improved docs for the flip function. (#41)

MHenderson · Mar 28, 2024 · 30ed168 · 30ed168
1 parent 17f66ea
commit 30ed168
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/R/flip.R b/R/flip.R
@@ -1,7 +1,10 @@
-#' Flip a grob.
+#' Flip a picture
 #'
-#' @param g A grob
-#' @return Flipped grob
+#' `flip` returns a new picture made by flipping the input picture along
+#' its vertical centre axis.
+#'
+#' @param g A `grid::grob` picture
+#' @return A flipped `grid::grob` picture
 #' @export
 flip <- function(g) {
   grid::editGrob(g, x = grid::unit(1, "npc") - g$x)

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