Clarify documentation of read_abs() to note that release_date arg onl…

…y reliably works for monthly (and some quarterly) data

R/read_abs.R

@@ -45,7 +45,8 @@
 #' @param release_date Either `"latest"` or a string coercible to a date, such as
 #' `"2022-02-01"`. If `"latest"`, the latest release of the requested data will
 #' be returned. If a date, (eg. `"2022-02-01"`) `read_abs()` will
-#' attempt to download the data from that month's release. See `Details`.
+#' attempt to download the data from that month's release. Note that this only
+#' works consistently as expected for monthly data. See `Details`.
 #'
 #' @return A data frame (tibble) containing the tidied data from the ABS time
 #' series table(s).
@@ -83,6 +84,8 @@
 #' for obtaining the version of series that were available on a given date.
 #' Note that you cannot supply more than one date to `release_date`. Note also
 #' that any dates prior to mid-2019 (the exact date varies by series) will fail.
+#' Specifying `release_date` only reliably works for monthly, and some
+#' quarterly, data. It does not work for annual data.
 #'
 #' @rdname read_abs
 #' @examples