Skip to content

Commit

Permalink
docs: make mf_init() documentation "internal"
Browse files Browse the repository at this point in the history
  • Loading branch information
rCarto committed Oct 18, 2024
1 parent 9ca6272 commit 856dfb3
Show file tree
Hide file tree
Showing 6 changed files with 3 additions and 4 deletions.
1 change: 1 addition & 0 deletions R/mf_init.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#' direction (bottom, left, top, right)
#' @param theme apply a theme (deprecated)
#' @export
#' @keywords internal
#' @importFrom sf st_bbox st_as_sfc st_geometry st_crs<-
#' @return No return value, a map is initiated.
#' @examples
Expand Down
1 change: 0 additions & 1 deletion R/package.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
#'
#' @section Map layout:
#' These functions are dedicated to the map layout design.
#' - [mf_init()] Initialize a map with a specific extent
#' - [mf_theme()] Set a theme
#' - [mf_shadow()] Plot a shadow
#' - [mf_background()] Plot a background image
Expand Down
2 changes: 1 addition & 1 deletion inst/tinytest/test_background.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
mtq <- mf_get_mtq()
mf_init(mtq)
mf_map(mtq)
expect_silent(mf_background(system.file("img/background.jpg",
package = "mapsf")))
expect_silent(mf_background(system.file("help/figures/logo.png",
Expand Down
1 change: 0 additions & 1 deletion man/mapsf.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/mf_init.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ reference:
- title: "Map Layout"
desc: These functions are dedicated to the map layout design.
contents:
- mf_init
- mf_theme
- mf_shadow
- mf_background
Expand Down

0 comments on commit 856dfb3

Please sign in to comment.