Skip to content

Commit 11bd849

Browse files
committed
docs: describe "sf" output argument value to ors_pois
1 parent 59d3469 commit 11bd849

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

R/pois.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
#' @templateVar return A list of points of interest in the area specified in `geometry`
2222
#' @template return-text
2323
#' @template return-parsed
24+
#' @template return-sf
25+
#' @templateVar valid_for `request = "pois"`
2426
#' @examples
2527
#' # POI categories list
2628
#' ors_pois('list')

man-roxygen/return-sf.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
#' @return - for `"sf"`, a simple features \code{\link[sf]{sf}} object.
1+
#' @return - for `"sf"`, a simple features \code{\link[sf]{sf}} object. <%= if (exists("valid_for")) paste0("Valid only for argument ", valid_for, ".") %>

man/ors_pois.Rd

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)