From 6fd3612a090b4e6b25c8715f5abef5564e8d7fec Mon Sep 17 00:00:00 2001
From: Martin Machyna <machyna@gmail.com>
Date: Tue, 4 Jan 2022 19:22:20 -0500
Subject: [PATCH] Warning for trim_osmdata function

---
 R/trim-osmdata.R    | 4 ++++
 man/trim_osmdata.Rd | 5 +++++
 2 files changed, 9 insertions(+)

diff --git a/R/trim-osmdata.R b/R/trim-osmdata.R
index 075b2227..aa7f936b 100644
--- a/R/trim-osmdata.R
+++ b/R/trim-osmdata.R
@@ -16,6 +16,10 @@
 #'
 #' @note It will generally be necessary to pre-load the \pkg{sf} package for
 #' this function to work correctly.
+#' @note Caution is advised when using polygons obtained from Nominatim via 
+#' getbb(..., format_out = "polygon"|"sf_polygon"). These shapes can be outdated 
+#' and thus could cause the trimming operation to not give results expected 
+#' based on the current state of the OSM data.
 #'
 #' @family transform
 #' @export
diff --git a/man/trim_osmdata.Rd b/man/trim_osmdata.Rd
index 951d3acd..7e46e5a8 100644
--- a/man/trim_osmdata.Rd
+++ b/man/trim_osmdata.Rd
@@ -28,6 +28,11 @@ Trim an \link{osmdata} object to within a bounding polygon
 \note{
 It will generally be necessary to pre-load the \pkg{sf} package for
 this function to work correctly.
+
+Caution is advised when using polygons obtained from Nominatim via
+getbb(..., format_out = "polygon"|"sf_polygon"). These shapes can be outdated
+and thus could cause the trimming operation to not give results expected
+based on the current state of the OSM data.
 }
 \examples{
 \dontrun{