docs: Minor tweaks + use roxygen Markdown + bring dev mod auto. (#911)

rstudio · Apr 2, 2024 · ff7fae2 · ff7fae2
1 parent 4f9a2d8
commit ff7fae2
Show file tree

Hide file tree

Showing 27 changed files with 86 additions and 75 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -82,3 +82,4 @@ Config/Needs/website: dplyr, geojsonio, ncdf4, tidyverse/tidytemplate
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.3.1
+Roxygen: list(markdown = TRUE)
diff --git a/R/layers.R b/R/layers.R
@@ -678,7 +678,7 @@ gridOptions <- function(
 #' Remove one or more features from a map, identified by \code{layerId}; or,
 #' clear all features of the given type or group.
 #'
-#' @note When used with a \code{\link{leaflet}}() map object, these functions
+#' @note When used with a [leaflet][leaflet()] map object, these functions
 #'   don't actually remove the features from the map object, but simply add an
 #'   operation that will cause those features to be removed after they are
 #'   added. In other words, if you add a polygon \code{"foo"} and the call
@@ -692,8 +692,8 @@ gridOptions <- function(
 #'
 #'   WMS tile layers are extensions of tile layers, so they can also be removed
 #'   or cleared via \code{removeTiles()} or \code{clearTiles()}.
-#' @param map a map widget object, possibly created from \code{\link{leaflet}}()
-#'   but more likely from \code{\link{leafletProxy}}()
+#' @param map a map widget object, possibly created from [leaflet()]
+#'   but more likely from [leafletProxy()]
 #' @param layerId character vector; the layer id(s) of the item to remove
 #' @return the new \code{map} object
 #'

diff --git a/R/legend.R b/R/legend.R
@@ -46,13 +46,13 @@
 #'   write your own function)
 #' @param title the legend title
 #' @param className extra CSS classes to append to the control, space separated
-#' @param layerId the ID of the legend; subsequent calls to \code{addLegend}
-#'   or \code{addControl} with the same \code{layerId} will replace this
-#'   legend. The ID can also be used with \code{removeControl}.
+#' @param layerId the ID of the legend; subsequent calls to \code{addLegend()}
+#'   or \code{addControl()} with the same \code{layerId} will replace this
+#'   legend. The ID can also be used with \code{removeControl()}.
 #' @param group \code{group} name of a leaflet layer group.
 #'   Supplying this value will tie the legend to the leaflet layer group
 #'   with this name and will auto add/remove the legend as the
-#'   group is added/removed, for example via layerControl.
+#'   group is added/removed, for example via `layerControl()`.
 #'   You will need to set the \code{group} when you add a layer
 #'   (e.g. \code{\link{addPolygons}}) and supply the same name here.
 #' @template data-getMapData

diff --git a/R/mapPane.R b/R/mapPane.R
@@ -5,7 +5,7 @@
 #' ordering. We recommend a \code{zIndex} value between 400 (the default
 #' overlay pane) and 500 (the default shadow pane). You can then use this pane
 #' to render overlays (points, lines, polygons) by setting the \code{pane}
-#' argument in \code{leafletOptions}. This will give you control
+#' argument in [leafletOptions()]. This will give you control
 #' over the order of the layers, e.g. points always on top of polygons.
 #' If two layers are provided to the same pane, overlay will be determined by
 #' order of adding. See examples below.

diff --git a/R/normalize.R b/R/normalize.R
@@ -38,8 +38,8 @@ metaData.list <- function(obj) obj
 #' Normalize data to a data frame or Spatial object.
 #'
 #' Given a data object and lng/lat arguments (which may be `NULL`)
-#' [meaning infer from data], formula [which should be evaluated with respect to the data], or
-#' vector data [which should be used as-is]) return a lng/lat data frame.
+#' \[meaning infer from data\], formula \[which should be evaluated with respect to the data\], or
+#' vector data \[which should be used as-is\]) return a lng/lat data frame.
 #'
 #' @param data map data
 #' @param lng,lat longitude and latitude

diff --git a/R/plugin-providers.R b/R/plugin-providers.R
@@ -71,7 +71,8 @@ providerTileOptions <- function(errorTileUrl = "", noWrap = FALSE,
 #'
 #' @name providers
 #' @export providers
-#' @rdname providers
+#' @examples
+#' providers
 NULL
 # Active binding added in zzz.R
 "providers"

diff --git a/man/addAwesomeMarkers.Rd b/man/addAwesomeMarkers.Rd
diff --git a/man/addGraticule.Rd b/man/addGraticule.Rd
diff --git a/man/addLegend.Rd b/man/addLegend.Rd
diff --git a/man/addMapPane.Rd b/man/addMapPane.Rd
diff --git a/man/addMiniMap.Rd b/man/addMiniMap.Rd
diff --git a/man/addRasterImage.Rd b/man/addRasterImage.Rd
diff --git a/man/addSimpleGraticule.Rd b/man/addSimpleGraticule.Rd
diff --git a/man/colorNumeric.Rd b/man/colorNumeric.Rd
diff --git a/man/derivePoints.Rd b/man/derivePoints.Rd
diff --git a/man/dispatch.Rd b/man/dispatch.Rd
diff --git a/man/expandLimitsBbox.Rd b/man/expandLimitsBbox.Rd
diff --git a/man/filterNULL.Rd b/man/filterNULL.Rd
diff --git a/man/icons.Rd b/man/icons.Rd
diff --git a/man/leaflet.Rd b/man/leaflet.Rd
diff --git a/man/map-layers.Rd b/man/map-layers.Rd
diff --git a/man/map-options.Rd b/man/map-options.Rd
diff --git a/man/providers.Rd b/man/providers.Rd
diff --git a/man/remove.Rd b/man/remove.Rd
diff --git a/man/showGroup.Rd b/man/showGroup.Rd
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
@@ -1,5 +1,8 @@
 url: https://rstudio.github.io/leaflet/
 
+development:
+  mode: auto
+
 template:
   package: tidytemplate
   assets: pkgdown/assets

diff --git a/vignettes/articles/raster.Rmd b/vignettes/articles/raster.Rmd
@@ -53,7 +53,8 @@ library(leaflet)
 ```{r eval=FALSE}
 library(raster)
 library(leaflet)
-r <- raster("https://rstudio.github.io/leaflet/nc/oisst-sst.nc")
+# you can download by accessing https://rstudio.github.io/leaflet/nc/oisst-sst.nc
+r <- raster("nc/oisst-sst.nc")
 ```
 
 ```{r}