Better documentation for make_*() and unnest() functions

R/geos-make.R

@@ -1,6 +1,13 @@
 
 #' Create geometries from vectors of coordinates
 #'
+#' These functions transform raw coordinates into point, line, polygon,
+#' features, or nest a vector of geometries into a MULTI* type or
+#' GEOMETRYCOLLECTION. See [wk::wk_coords()], [geos_unnest()], or
+#' [wk::wk_flatten()] to perform inverse operations; see [wk::xy()],
+#' [wk::wk_linestring()], [wk::wk_polygon()], or [wk::wk_collection()] for
+#' generic versions that work with non-GEOS types.
+#'
 #' @param x,y,z Vectors of coordinate values
 #' @param feature_id,ring_id Vectors for which a change in sequential values
 #'   indicates a new feature or ring. Use [factor()] to convert from a character

R/geos-unnest.R

@@ -1,10 +1,21 @@
 
 #' Unnest nested geometries
 #'
+#' Ths function flattens nested geometries (i.e., multi or
+#' geometrycollection types) into a vector with the same or fewer levels of
+#' nesting. See [geos_geometry_n()] to access individual geometries within a
+#' collection; see [wk::wk_flatten()] for a version of this function that
+#' works with non-GEOS geometries; see [geos_make_collection()] and
+#' [wk::wk_collection()] for functions that perform the inverse operation.
+#'
 #' @inheritParams geos_read_wkt
-#' @inheritParams wkutils::wkt_unnest
+#' @param keep_empty If `TRUE`, EMPTY geomtries iare left as-is rather than
+#'   collapsing to length 0.
+#' @param keep_multi If `TRUE`, MULTI* geometries are not expanded to
+#'   sub-features (i.e., only GEOMETRYCOLLECTIONs are).
+#' @param max_depth The maximum recursive GEOMETRYCOLLECTION depth to unnest.
 #'
-#' @return A [GEOS geometry vector][as_geos_geometry] with a length
+#' @return A [GEOS geometry vector][as_geos_geometry], with a length
 #'   greater than or equal to `geom` with an attribute "lengths"
 #'   that can be used to map elements of the result to the
 #'   original item.