Skip to content

Commit 8cf4b84

Browse files
committed
Fix and improve docs
1 parent 7b11dbb commit 8cf4b84

File tree

7 files changed

+10
-9
lines changed

7 files changed

+10
-9
lines changed

R/get-osmdata-sf.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
#' @param q An object of class `overpass_query` constructed with
88
#' [opq()] and [add_osm_feature()] or a string with a valid query, such
99
#' as `"(node(39.4712701,-0.3841326,39.4713799,-0.3839475);); out;"`.
10-
#' 39.4712701,-0.3841326,39.4713799,-0.3839475
1110
#' May be be omitted, in which case the [osmdata] object will not
1211
#' include the query. See examples below.
1312
#' @param doc If missing, `doc` is obtained by issuing the overpass query,

R/opq.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@
4949
#' @return An `overpass_query` object
5050
#'
5151
#' @details The `out` statement for `tags`, `tags center`and `id`, do not return
52-
#' geometries. Neither `out = "meta"` nor `adiff = TRUE` options are implemented
53-
#' for all `osmdata_*` functions yet. Use [osmdata_xml] or [osmdata_data_frame]
54-
#' to get the result of these queries. See the documentation of the [out
52+
#' geometries. `adiff = TRUE` option is not implemented for all `osmdata_*` functions yet.
53+
#' Use [osmdata_xml] or [osmdata_data_frame] to get the result of these queries. See the
54+
#' documentation of the [out
5555
#' statement](https://wiki.openstreetmap.org/wiki/Overpass_API/Overpass_QL#out)
5656
#' and [augmented
5757
#' difference](https://wiki.openstreetmap.org/wiki/Overpass_API/Overpass_QL#Augmented-difference_between_two_dates_(adiff))

R/osmdata-package.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
#' \item [overpass_status()]: Retrieve status of the overpass API
1818
#' \item [opq()]: Build an overpass query
1919
#' \item [add_osm_feature()]: Add a feature to an overpass query
20+
#' \item [add_osm_features()]: Add multiple features to an Overpass query
21+
#' \item [filter_osm_user()]: Add an user filter to an Overpass query
2022
#' \item [opq_string()]: Convert an osmdata query to overpass API string
2123
#' }
2224
#'

man/opq.Rd

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

man/osmdata-package.Rd

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

man/osmdata_sf.Rd

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

man/osmdata_sp.Rd

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

0 commit comments

Comments
 (0)