From ac0704ca7e62002a21746c44be3cf0ba0960ff6d Mon Sep 17 00:00:00 2001 From: mpadge Date: Thu, 20 Jan 2022 20:51:44 +0100 Subject: [PATCH] tidy docs for #263 --- DESCRIPTION | 2 +- R/trim-osmdata.R | 6 +++--- codemeta.json | 2 +- man/trim_osmdata.Rd | 6 +++--- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 8df24b47..1d7d1af2 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: osmdata Title: Import 'OpenStreetMap' Data as Simple Features or Spatial Objects -Version: 0.1.8.017 +Version: 0.1.8.018 Authors@R: c( person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre")), person("Bob", "Rudis", role = "aut"), diff --git a/R/trim-osmdata.R b/R/trim-osmdata.R index aa7f936b..1e066be3 100644 --- a/R/trim-osmdata.R +++ b/R/trim-osmdata.R @@ -17,9 +17,9 @@ #' @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. +#' `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/codemeta.json b/codemeta.json index cedbb1fa..08ca7803 100644 --- a/codemeta.json +++ b/codemeta.json @@ -11,7 +11,7 @@ "codeRepository": "https://github.com/ropensci/osmdata/", "issueTracker": "https://github.com/ropensci/osmdata/issues", "license": "https://spdx.org/licenses/GPL-3.0", - "version": "0.1.8.017", + "version": "0.1.8.018", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R", diff --git a/man/trim_osmdata.Rd b/man/trim_osmdata.Rd index 7e46e5a8..4e580b8c 100644 --- a/man/trim_osmdata.Rd +++ b/man/trim_osmdata.Rd @@ -30,9 +30,9 @@ 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. +\code{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{