Skip to content

Commit 528d50e

Browse files
authored
Fix documentation for k in s2_cell_child() (#230)
* redocument * fix doc for k * fix documentation
1 parent 90ae67a commit 528d50e

8 files changed

+8
-24
lines changed

R/s2-bounds.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
#' the order of points or polylines. `lng_lo` values larger than `lng_hi` indicate
99
#' regions that span the antimeridian, see the Fiji example.
1010
#'
11-
#' @inheritParams s2_is_collection
11+
#' @param x An [s2_geography()] vector.
1212
#' @export
1313
#' @return Both functions return a `data.frame`:
1414
#'

R/s2-cell.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Summary.s2_cell <- function(x, ..., na.rm = FALSE) {
183183
#'
184184
#' @param x,y An [s2_cell()] vector
185185
#' @param level An integer between 0 and 30, inclusive.
186-
#' @param k An integer between 1 and 4
186+
#' @param k An integer between 0 and 3
187187
#' @param radius The radius to use (e.g., [s2_earth_radius_meters()])
188188
#' @param na.rm Remove NAs prior to computing aggregate?
189189
#' @export

man/s2_boundary.Rd

+1-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/s2_bounds_cap.Rd

+1-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/s2_cell_is_valid.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/s2_contains.Rd

+1-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/s2_geog_point.Rd

+1-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/s2_plot.Rd

+1-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)