Update manual a bit

r-rust · Nov 18, 2022 · a64cf4e · a64cf4e
1 parent a6b165a
commit a64cf4e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/R/hello.R b/R/hello.R
@@ -1,6 +1,11 @@
 #' Hello Rust!
 #'
-#' Examples of rust functions via C.
+#' Minimal examples of calling rust functions in R via C.
+#'
+#' These functions call out to rust functions defined in the `myrustlib` cargo
+#' crate which is embedded in this package. They return values generated in Rust,
+#' such as a UTF-8 string or random number. In addition, `runthreads` is an
+#' example of a multi-threaded rust function.
 #'
 #' @export
 #' @rdname hellorust

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