Add NEWS, docs for timeout

r-hub · Apr 22, 2024 · 5c0aed7 · 5c0aed7
1 parent 1b58d34
commit 5c0aed7
Show file tree

Hide file tree

Showing 3 changed files with 237 additions and 221 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,8 @@
 # pkgsearch (development version)
 
+* pkgsearch now uses the `timeout` option to set the limit for the total
+  time of each HTTP request (#125, @gladkia).
+
 # pkgsearch 3.1.3
 
 * No user visible changes.

diff --git a/README.Rmd b/README.Rmd
@@ -186,6 +186,15 @@ ps("gabor", size = 5)
 ps("Gábor", size = 5)
 ```
 
+## Configuration
+
+### Options
+
+* `timeout`: pkgsearch follows the `timeout` options for HTTP requests
+  (i.e. for `pkg_search()` and `advanced_search()`. `timeout` is the limit
+  for the total time of the HTTP request, and it is in seconds. See
+  `?options` for details.
+
 ## More info
 
 See the [complete documentation](https://r-hub.github.io/pkgsearch/).