From c935ea7f5c0fc7ec48ac4453f9d9cb377af4498c Mon Sep 17 00:00:00 2001 From: Gregory Jefferis Date: Tue, 13 Jul 2021 19:14:14 +0100 Subject: [PATCH] Clarify intent of pagesize argument * should close #83 --- R/publications.r | 6 ++++-- man/get_publications.Rd | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/R/publications.r b/R/publications.r index afbcbda..6d31ab4 100644 --- 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 index f9a3af6..d1fc4e8 100644 --- a/man/get_publications.Rd +++ b/man/get_publications.Rd @@ -25,8 +25,10 @@ parameter.} \item{cstop}{an integer specifying the last article to process.} -\item{pagesize}{an integer specifying the number of articles to -fetch} +\item{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.} \item{flush}{should the cache be flushed? Search results are cached by default to speed up repeated queries. If this argument