doc tweaks

R/job.R

@@ -69,8 +69,9 @@ job_info_forecast_url <- function(zoltar_connection, the_job_info) {
 #' passed (the expiration time) or 2) the Job is not complete and therefore has not saved the data file. For
 #' the latter you may use `busy_poll_job()` to ensure the job is done.
 #'
-#' @return A `data.frame` of Job's data. The columns depend on is_forecast_query. Full documentation at
-#'   \url{https://docs.zoltardata.com/}.
+#' @return A `data.frame` of Job's data. The columns depend on query_type - see
+#'   \url{https://docs.zoltardata.com/fileformats/#truth-data-format-csv} and
+#'   \url{https://docs.zoltardata.com/fileformats/#forecast-data-format-csv}.
 #' @param zoltar_connection A `ZoltarConnection` object as returned by \code{\link{new_connection}}
 #' @param job_url URL of a valid job in zoltar_connection that has a data file associated with it
 #' @param query_type A character indicating the type of query to run. Must be one of: "forecasts" or "truth".

tests/testthat/test-project.R

@@ -48,7 +48,7 @@ test_that("create_project() calls re_authenticate_if_necessary(), and returns a
 test_that("submit_query() calls re_authenticate_if_necessary()", {
   zoltar_connection <- new_connection("http://example.com")
 
-  # test `is_forecast_query = "forecasts"` POSTs to correct uri
+  # test `query_type = "forecasts"` POSTs to correct uri
   m <- mock()
   # NB: todo this overrides `test_that("submit_query() creates a Job"` !?:
   job_json <- jsonlite::read_json("data/job-2.json")
@@ -63,7 +63,7 @@ test_that("submit_query() calls re_authenticate_if_necessary()", {
   })
 
 
-  # test `is_forecast_query = "truth"` POSTs to correct uri
+  # test `query_type = "truth"` POSTs to correct uri
   m <- mock()
   # NB: todo this overrides `test_that("submit_query() creates a Job"` !?:
   job_json <- jsonlite::read_json("data/job-2.json")