fixing roxygen2 package-level documentation weirdness

CornellLabofOrnithology · Aug 21, 2023 · 94927aa · 94927aa
1 parent 0277574
commit 94927aa
Show file tree

Hide file tree

Showing 35 changed files with 207 additions and 163 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -2,6 +2,7 @@
 
 - retain breeding codes in `auk_zerofill()`
 - changes to conform with deprecation of `.data$` in tidyselect expressions
+- changes to package-level documentation in roxygen2
 
 # auk 0.6.0
 

diff --git a/R/auk-package.r b/R/auk-package.r
@@ -3,9 +3,11 @@
 #' Tools for extracting and processing eBird data from the eBird Basic Dataset 
 #' (EBD).
 #'
-#' @name auk
-#' @docType package
-#' @importFrom stringr str_interp
-#' @importFrom rlang .data
 #' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+#' @importFrom rlang .data
+#' @importFrom stringr str_interp
+## usethis namespace: end
 NULL
diff --git a/README.md b/README.md
@@ -294,7 +294,7 @@ eBird Basic Dataset files can be read with `read_ebd()`:
     #>  $ locality_type            : chr [1:494] "P" "P" "P" "P" ...
     #>  $ latitude                 : num [1:494] 20.7 15.8 15.8 15.8 15.7 ...
     #>  $ longitude                : num [1:494] -88.6 -93 -93 -92.9 -92.9 ...
-    #>  $ observation_date         : Date[1:494], format: "2010-09-05" "2011-08-18" ...
+    #>  $ observation_date         : Date[1:494], format: "2010-09-05" "2011-08-18" "2012-02-02" ...
     #>  $ time_observations_started: chr [1:494] "06:30:00" "08:00:00" "09:13:00" "06:40:00" ...
     #>  $ observer_id              : chr [1:494] "obsr55719" "obsr313215" "obsr313215" "obsr313215" ...
     #>  $ sampling_event_identifier: chr [1:494] "S6852862" "S14432467" "S39033556" "S38303088" ...

diff --git a/cran-comments.md b/cran-comments.md
@@ -2,6 +2,7 @@
 
 - retain breeding codes in `auk_zerofill()`
 - changes to conform with deprecation of `.data$` in tidyselect expressions
+- changes to package-level documentation in roxygen2
 
 # Test environments
 

diff --git a/docs/articles/auk.html b/docs/articles/auk.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -4,5 +4,5 @@ pkgdown_sha: ~
 articles:
   auk: auk.html
   development: development.html
-last_built: 2023-07-07T17:31Z
+last_built: 2023-08-21T16:01Z
 
diff --git a/docs/reference/auk-package.html b/docs/reference/auk-package.html