From d737c554e3763b2a2bf2bc0d2df4c819c51b892a Mon Sep 17 00:00:00 2001
From: Paul Lietar <pl2113@ic.ac.uk>
Date: Thu, 3 Oct 2024 15:13:54 +0100
Subject: [PATCH] Fix docs

---
 R/rrq.R                        |  8 ++++++--
 man/hipercow_rrq_controller.Rd | 12 +++++++++++-
 2 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/R/rrq.R b/R/rrq.R
index 27e5198e..5d4b71b7 100644
--- a/R/rrq.R
+++ b/R/rrq.R
@@ -20,16 +20,20 @@
 ##' @param set_as_default Set the rrq controller to be the default;
 ##'   this is usually what you want.
 ##'
+##' @param queue_id The rrq queue id to use. You shouldn't need to pass a value
+##'   for this: the queue id can be found from the hipercow state directory, or
+##'   a new one is created if needed.
+##'
 ##' @inheritParams task_create_expr
 ##'
 ##' @return An [rrq::rrq_controller] object.
 ##'
 ##' @export
 hipercow_rrq_controller <- function(..., set_as_default = TRUE, driver = NULL,
-                                    queue_id = NA, root = NULL) {
+                                    queue_id = NULL, root = NULL) {
   root <- hipercow_root(root)
   call <- rlang::current_env()
-  if (is.na(queue_id)) {
+  if (is.null(queue_id)) {
     driver <- hipercow_driver_select(driver, TRUE, root, call)
     r <- rrq_prepare(driver, root, ..., call = call)
   } else {
diff --git a/man/hipercow_rrq_controller.Rd b/man/hipercow_rrq_controller.Rd
index f78484b8..a72c9172 100644
--- a/man/hipercow_rrq_controller.Rd
+++ b/man/hipercow_rrq_controller.Rd
@@ -4,7 +4,13 @@
 \alias{hipercow_rrq_controller}
 \title{Create an rrq controller}
 \usage{
-hipercow_rrq_controller(..., set_as_default = TRUE, driver = NULL, root = NULL)
+hipercow_rrq_controller(
+  ...,
+  set_as_default = TRUE,
+  driver = NULL,
+  queue_id = NULL,
+  root = NULL
+)
 }
 \arguments{
 \item{...}{Additional arguments passed through to
@@ -22,6 +28,10 @@ your task with it.  If you have more than one driver configured,
 then we will error, though in future versions we may fall back
 on a default driver if you have one configured.}
 
+\item{queue_id}{The rrq queue id to use. You shouldn't need to pass a value
+for this: the queue id can be found from the hipercow state directory, or
+a new one is created if needed.}
+
 \item{root}{A hipercow root, or path to it. If \code{NULL} we search up
 your directory tree.}
 }