Correct outdated docs

Author: arcresu

R/configure_inset.R

@@ -1,9 +1,8 @@
 #' Configure transformations underpinning a map inset
 #'
-#' The configuration returned by this function will normally be passed to the
-#' coordinate system via [coord_sf_inset()]. Insets can either be circular
-#' (if \code{radius} is specified) or rectangular (if \code{hwidth} and
-#' optionally \code{hheight} are specified).
+#' The configuration returned by this function will often be passed to the
+#' coordinate system via [coord_sf_inset()] so that it is propagated to all
+#' relevant layers.
 #'
 #' The default \code{crs_working} uses the equidistant cylindrical coordinate
 #' reference system with the latitude of true scale set to match the latitude of

R/inset_shape_circle.R

@@ -5,6 +5,7 @@
 #'   An [sf::st_point()] or a vector of longitude and latitude are also accepted.
 #'   If a CRS cannot be determined, WGS 84 is assumed.
 #' @param radius Radius of the inset circle in the units of the inset's `crs_working`.
+#' @returns A shape definition suitable for use with [configure_inset()].
 #' @family shapes
 #' @seealso [configure_inset()]
 #' @export

R/inset_shape_rectangle.R

@@ -7,6 +7,7 @@
 #' @param hwidth Half width of the inset in the units of the inset's `crs_working`.
 #' @param hheight Half height of the inset in the units of the inset's `crs_working`.
 #'   Defaults to the same value as `hwidth`.
+#' @returns A shape definition suitable for use with [configure_inset()].
 #' @family shapes
 #' @seealso [configure_inset()]
 #' @export

R/inset_shape_sf.R

@@ -5,6 +5,7 @@
 #'
 #' @param geometry A simple features geometry that is either a polygon or
 #'   multipolygon, and is valid and simple.
+#' @returns A shape definition suitable for use with [configure_inset()].
 #' @family shapes
 #' @seealso [configure_inset()]
 #' @export