diff --git a/deltachat-repl/README.md b/deltachat-repl/README.md index 213554fd3..ee3e8298e 100644 --- a/deltachat-repl/README.md +++ b/deltachat-repl/README.md @@ -1,7 +1,7 @@ # Delta Chat REPL -This is a simple [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) frontend build on top of delta chat core. -It's purpose is to help with quick testing during development, it is not meant for end users. +This is a simple [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) frontend built on top of Delta Chat core. +Its purpose is to help with quick testing during development, it is not meant for end users. Dependencies: - if you want to use `getqr` you need `qrencode` (macOS: `brew install qrencode`) @@ -16,14 +16,14 @@ Type in `help` to learn about what comands are available. ## Usage with `tokio-console` -Tokio is the async runtime that delta chat core uses. -Core uses tokio tasks, which is something similar to a thread. -`tokio-console` is like a task manager for these tokio-tasks. +Tokio is an async runtime that Delta Chat core uses. +Core uses Tokio tasks, which are something similar to threads. +`tokio-console` is like a task manager for these Tokio tasks. Examples of tasks: -- The event loop in the repl tool which processes events received from core +- The event loop in the REPL tool which processes events received from core - The repl loop itself which waits for and executes user commands -- The imap task that manages imap connection in core +- The IMAP task that manages IMAP connection in core ``` RUSTFLAGS="--cfg tokio_unstable" cargo run @@ -34,7 +34,7 @@ You can install it via `cargo install tokio-console`. ### Quick Example -An example session in the repl tool. +An example session in the REPL tool: ``` RUSTFLAGS="--cfg tokio_unstable" cargo run test-db/db @@ -45,10 +45,10 @@ listchats getqr ``` -If it crashes you can just start it again and use the openpgp4fpr url instead of scanning the code from the terminal. +If it crashes you can just start it again and use the openpgp4fpr URL instead of scanning the code from the terminal. Or install `qrencode` to fix the crash and run `getqr` again. -Use the qrcode/openpgp4fpr link to setup the contact on deltachat. +Use the qrcode/openpgp4fpr link to setup the contact on Delta Chat. Then write a message to that new contact, after that we can accept the chat in the repl tool and send a reply: ``` diff --git a/deltachat-rpc-server/README.md b/deltachat-rpc-server/README.md index d2f921057..2185db895 100644 --- a/deltachat-rpc-server/README.md +++ b/deltachat-rpc-server/README.md @@ -38,8 +38,8 @@ Run `deltachat-rpc-server --openrpc` to get [OpenRPC](https://open-rpc.org/) spe ## Usage with `tokio-console` -When build with `RUSTFLAGS="--cfg tokio_unstable"` console-subscriber is enabled. -That means that you can use [`tokio-console`](https://github.com/tokio-rs/console) to inspect active tokio tasks. +When built with `RUSTFLAGS="--cfg tokio_unstable"`, console-subscriber is enabled. +That means that you can use [`tokio-console`](https://github.com/tokio-rs/console) to inspect active Tokio tasks. You can install it via `cargo install tokio-console`. ```sh diff --git a/src/tools.rs b/src/tools.rs index 9aa474c59..db44ca97d 100644 --- a/src/tools.rs +++ b/src/tools.rs @@ -711,7 +711,7 @@ pub(crate) fn inc_and_check( /// Spawns a named asynchronous task if the `tokio_unstable` feature is enabled. /// /// Spawns a new asynchronous task, returning a [tokio::task::JoinHandle] for it. -/// The provided future will start running in the background immediately when spawn is called, even if you don't await the returned JoinHandle. +/// The provided future will start running in the background immediately when the function is called, even if you don't await the returned JoinHandle. /// See [tokio::task::spawn]. /// /// If the rustflag `tokio_unstable` is active, the task will be given the specified `name` @@ -720,7 +720,7 @@ pub(crate) fn inc_and_check( /// /// # Parameters /// -/// - `name`: The name of the task (used only if `tokio_unstable` is enabled). +/// - `name`: The name of the task. /// - `future`: The future to be executed, which must implement `Future`, be `Send`, and `'static`. /// /// # Returns @@ -774,7 +774,7 @@ macro_rules! spawn_named_task { /// Spawns a named blocking task if the `tokio_unstable` feature is enabled. /// /// Spawns a new blocking task, returning a [tokio::task::JoinHandle] for it. -/// The provided future will start running in the background immediately when spawn is called, even if you don't await the returned JoinHandle. +/// The provided future will start running in the background immediately when the function is called, even if you don't await the returned JoinHandle. /// See [tokio::task::spawn_blocking]. /// /// If the rustflag `tokio_unstable` is active, the task will be given the specified `name` @@ -783,7 +783,7 @@ macro_rules! spawn_named_task { /// /// # Parameters /// -/// - `name`: The name of the task (used only if `tokio_unstable` is enabled). +/// - `name`: The name of the task /// - `future`: The future to be executed, which must implement `Future`, be `Send`, and `'static`. /// /// # Returns