Clarify intent of pagesize argument

* should close #83
jkeirstead · Jul 13, 2021 · c935ea7 · c935ea7
1 parent 89f35a0
commit c935ea7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/R/publications.r b/R/publications.r
@@ -13,8 +13,10 @@ utils::globalVariables(c("."))
 ##' parameter.
 ##' @param cstop an integer specifying the last article to
 ##' process.
-##' @param pagesize an integer specifying the number of articles to
-##' fetch
+##' @param pagesize an integer specifying the number of articles to fetch in one
+##'   batch. It is recommended to leave the default value of 100 unless you
+##'   experience time-out errors. Note this is \emph{not} the \bold{total}
+##'   number of publications to fetch.
 ##' @param flush should the cache be flushed?  Search results are
 ##' cached by default to speed up repeated queries.  If this argument
 ##' is TRUE, the cache will be cleared and the data reloaded from

diff --git a/man/get_publications.Rd b/man/get_publications.Rd