Document the rot function. (#40)

.Rbuildignore

@@ -2,3 +2,6 @@
 ^\.Rproj\.user$
 ^CONDUCT\.md$
 ^.github$
+^funcgeo\.Rcheck$
+^funcgeo.*\.tar\.gz$
+^funcgeo.*\.tgz$

.gitignore

@@ -2,3 +2,6 @@
 .Rhistory
 .RData
 .Ruserdata
+funcgeo.Rcheck/
+funcgeo*.tar.gz
+funcgeo*.tgz

DESCRIPTION

@@ -1,14 +1,14 @@
 Package: funcgeo
 Type: Package
 Title: Functional Geometry in R
-Version: 0.2.1.9000
+Version: 0.2.1.9001
 Authors@R: person("Matthew", "Henderson", email = "[email protected]",
                   role = c("aut", "cre"))
 Description: Peter Henderson's Functional Geometry in R.
 License: MIT + file LICENSE
 Imports:
     grid
 Encoding: UTF-8
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 URL: https://github.com/mhenderson/funcgeo
 BugReports: https://github.com/mhenderson/funcgeo/issues

R/rot.R

@@ -1,8 +1,12 @@
-#' Rotate a grob.
+#' Rotate a picture
 #'
-#' @param g A grob
+#' `rot` returns a new picture, made by rotating the input picture. If no angle
+#' is specified then the new picture will be rotated 90 degrees. A different
+#' angle can be specified with the `angle` argument.
+#'
+#' @param g A `grid::grob` picture
 #' @param angle An angle
-#' @return Rotated grob
+#' @return A rotated `grid::grob` picture
 #' @export
 rot <- function(g, angle = 90) {
   grid::editGrob(g, vp = grid::viewport(