docs: nicer documentation for weatherCodes

Modern roxygen2
davidcarslaw · Sep 29, 2023 · 373d957 · 373d957
1 parent 12e45d3
commit 373d957
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 8 deletions.
diff --git a/R/weatherCodes.R b/R/weatherCodes.R
@@ -3,10 +3,10 @@
 #' This data frame consists of the weather description codes used in the ISD. It
 #' is not of general use to most users.
 #'
-#' @name weatherCodes
-#' @docType data
-#' @keywords datasets
+#' \describe{
+#'   \item{pwc}{Weather code, which can be merged with the `pwc` column in [importNOAA()] datasets.}
+#'   \item{description}{Description associated with the weather codes.}
+#' }
 #' @examples
-#' ## basic structure
-#' head(weatherCodes)
-NULL
+#' weatherCodes
+"weatherCodes"
diff --git a/man/weatherCodes.Rd b/man/weatherCodes.Rd