CRAN release 0.3.1

shikokuchuo · Sep 25, 2023 · 0ee4b3e · 0ee4b3e
1 parent 09e96c4
commit 0ee4b3e
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: mirai.promises
 Type: Package
 Title: Make 'Mirai' 'Promises'
-Version: 0.3.0.9000
+Version: 0.3.1
 Description: Allows 'mirai' objects encapsulating asynchronous computations,
     from the 'mirai' package by Gao (2023) <doi:10.5281/zenodo.7912722>, to be
     used interchangeably with 'promise' objects from the 'promises' package by

diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,6 @@
-# mirai.promises 0.3.0.9000 (development)
+# mirai.promises 0.3.1
 
+* Documents that importing `polling()` in a package allows access to the S3 methods.
 * Depends on `mirai` and `promises` so no longer necessary to attach all 3 packages.
 
 # mirai.promises 0.3.0

diff --git a/README.Rmd b/README.Rmd
@@ -49,6 +49,8 @@ This app takes c. 2s to start compared to the 8s it would otherwise take if the
 
 The auxiliary function `polling()` may be used to customise the frequency with which to poll for promise resolution (defaults to every 100 ms).
 
+Package authors wishing to use the S3 methods contained within this package may simply import the `polling()` function to make them available.
+
 ```{r example, eval=FALSE}
 library(mirai.promises)
 library(shiny)
@@ -87,8 +89,6 @@ server <- function(input, output, session) {
 shinyApp(ui = ui, server = server)
 ```
 
-Package authors wishing to use the S3 methods contained within this package may simply import the `polling()` function to make them available.
-
 ### Thanks
 
 [Daniel Falbel](https://github.com/dfalbel/) for the original version of the above example and agreeing to its use here, as well as the specific use case that motivated this package.

diff --git a/README.md b/README.md
@@ -47,6 +47,10 @@ The auxiliary function `polling()` may be used to customise the
 frequency with which to poll for promise resolution (defaults to every
 100 ms).
 
+Package authors wishing to use the S3 methods contained within this
+package may simply import the `polling()` function to make them
+available.
+
 ``` r
 library(mirai.promises)
 library(shiny)
@@ -85,10 +89,6 @@ server <- function(input, output, session) {
 shinyApp(ui = ui, server = server)
 ```
 
-Package authors wishing to use the S3 methods contained within this
-package may simply import the `polling()` function to make them
-available.
-
 ### Thanks
 
 [Daniel Falbel](https://github.com/dfalbel/) for the original version of