Skip to content

Commit

Permalink
update DESCRIPTION
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Oct 1, 2024
1 parent 4df306f commit 3cf38bc
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 19 deletions.
9 changes: 5 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ Description: Designed for simplicity, a 'mirai' evaluates an R expression
network, with the result automatically available upon completion. Modern
networking and concurrency built on 'nanonext' and 'NNG' (Nanomsg Next Gen)
ensure reliable and efficient scheduling, over fast inter-process
communications or TCP/IP secured by TLS. Features built-in queueing to
handle many more tasks than available processes, no storage on the file
system, support for otherwise non-exportable reference objects, an
event-driven promises implementation, and asynchronous parallel map.
communications or TCP/IP secured by TLS. Advantages include being inherently
queued thus handling many more tasks than available processes, no storage on
the file system, support for otherwise non-exportable reference objects, an
event-driven promises implementation, and built-in asynchronous parallel
map.
Authors@R:
c(person(given = "Charlie",
family = "Gao",
Expand Down
9 changes: 5 additions & 4 deletions R/mirai-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@
#' result automatically available upon completion. Modern networking and
#' concurrency built on 'nanonext' and 'NNG' (Nanomsg Next Gen) ensure
#' reliable and efficient scheduling, over fast inter-process communications
#' or TCP/IP secured by TLS. Features built-in queueing to handle many more
#' tasks than available processes, no storage on the file system, support
#' for otherwise non-exportable reference objects, an event-driven promises
#' implementation, and asynchronous parallel map.
#' or TCP/IP secured by TLS. Advantages include being inherently queued thus
#' handling many more tasks than available processes, no storage on the file
#' system, support for otherwise non-exportable reference objects, an
#' event-driven promises implementation, and built-in asynchronous parallel
#' map.
#'
#' @section Notes:
#'
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Designed for simplicity, a 'mirai' evaluates an R expression asynchronously in a
<br /><br />
Modern networking and concurrency built on [nanonext](https://github.com/shikokuchuo/nanonext/) and [NNG](https://nng.nanomsg.org/) (Nanomsg Next Gen) ensure reliable and efficient scheduling, over fast inter-process communications or TCP/IP secured by TLS.
<br /><br />
Features built-in queueing to handle many more tasks than available processes, no storage on the file system, support for otherwise non-exportable reference objects, an event-driven promises implementation, and asynchronous parallel map.
Advantages include being inherently queued thus handling many more tasks than available processes, no storage on the file system, support for otherwise non-exportable reference objects, an event-driven promises implementation, and built-in asynchronous parallel map.
<br /><br />

### Quick Start
Expand Down
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ completion. <br /><br /> Modern networking and concurrency built on
[nanonext](https://github.com/shikokuchuo/nanonext/) and
[NNG](https://nng.nanomsg.org/) (Nanomsg Next Gen) ensure reliable and
efficient scheduling, over fast inter-process communications or TCP/IP
secured by TLS. <br /><br /> Features built-in queueing to handle many
more tasks than available processes, no storage on the file system,
support for otherwise non-exportable reference objects, an event-driven
promises implementation, and asynchronous parallel map. <br /><br />
secured by TLS. <br /><br /> Advantages include being inherently queued
thus handling many more tasks than available processes, no storage on
the file system, support for otherwise non-exportable reference objects,
an event-driven promises implementation, and built-in asynchronous
parallel map. <br /><br />

### Quick Start

Expand Down Expand Up @@ -74,7 +75,7 @@ To wait for and collect the return value, use the mirai’s `[]` method:

``` r
m[]
#> [1] 5.663356 5.131649 6.319674 5.036944 6.571185
#> [1] 6.851895 6.525120 8.516672 6.846605 8.751862
```

As a mirai represents an async operation, it is never necessary to wait
Expand All @@ -88,7 +89,7 @@ while (unresolved(m)) {
m
#> < mirai [$data] >
m$data
#> [1] 5.663356 5.131649 6.319674 5.036944 6.571185
#> [1] 6.851895 6.525120 8.516672 6.846605 8.751862
```

#### Daemons
Expand Down
9 changes: 5 additions & 4 deletions man/mirai-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3cf38bc

Please sign in to comment.