docs: make mf_init() documentation "internal"

riatelab · Oct 18, 2024 · 856dfb3 · 856dfb3
1 parent 9ca6272
commit 856dfb3
Show file tree

Hide file tree

Showing 6 changed files with 3 additions and 4 deletions.
diff --git a/R/mf_init.R b/R/mf_init.R
@@ -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

diff --git a/R/package.R b/R/package.R
@@ -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

diff --git a/inst/tinytest/test_background.R b/inst/tinytest/test_background.R
@@ -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",

diff --git a/man/mapsf.Rd b/man/mapsf.Rd
diff --git a/man/mf_init.Rd b/man/mf_init.Rd
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
@@ -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