Skip to content

Commit

Permalink
Move comment properly
Browse files Browse the repository at this point in the history
  • Loading branch information
olivroy committed Sep 2, 2024
1 parent 13a989d commit ac32831
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion R/geom-predicates.R
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ st_overlaps = function(x, y, sparse = TRUE, prepared = TRUE, ...)
#' see also \link{distinct.sf} to find records where geometries AND attributes are distinct.
#' @param remove_self logical; if `TRUE` (and `y` is missing) return only indexes of geometries different from the current index; this can be used to omit self-intersections; see examples.
#' This argument can be used for all geometry predicates
#' @param ... passed on to [s2::s2_equals()]
#' @param ... passed on to [s2::s2_options()]
#' @export
#' @family geometric binary predicates for two spatial objects
#' @examples
Expand All @@ -241,6 +241,7 @@ st_overlaps = function(x, y, sparse = TRUE, prepared = TRUE, ...)
#' st_equals(p)
#' st_equals(p, remove_self = TRUE)
#' (u = st_equals(p, retain_unique = TRUE))
#' # retain the records with unique geometries:
#' p[-unlist(u),]
st_equals = function(x, y, sparse = TRUE, prepared = FALSE, ...,
retain_unique = FALSE, remove_self = FALSE) {
Expand Down
3 changes: 2 additions & 1 deletion man/st_equals.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ac32831

Please sign in to comment.