Skip to content

Commit

Permalink
Update wordings in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
devashishdxt committed Dec 19, 2019
1 parent 9e0858c commit 86f8c05
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ So, internal mutability must be handled using thread safe (`Arc`, `Mutex`, etc.)
After implementing all three above mentioned `trait`s, you can create a `Server` object and use `Server::run()` to start
ABCI application.

`Server::run()` is an `async` function and returns a `Future`. So, you'll need an executor to run `Future` returned from
`Server::run()`. `async-std` and `tokio` are two popular options. In `counter` example, we use `async-std`'s executor.
`Server::run()` is an `async` function and returns a `Future`. So, you'll need an executor to drive `Future` returned
from `Server::run()`. `async-std` and `tokio` are two popular options. In `counter` example, we use `async-std`'s
executor.

To know more, go to `examples/` to see a sample ABCI application.

Expand Down
5 changes: 3 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@
//! After implementing all three above mentioned `trait`s, you can create a `Server` object and use `Server::run()`to start
//! ABCI application.
//!
//! `Server::run()` is an `async` function and returns a `Future`. So, you'll need an executor to run `Future` returned from
//! `Server::run()`. `async-std` and `tokio` are two popular options. In `counter` example, we use `async-std`'s executor.
//! `Server::run()` is an `async` function and returns a `Future`. So, you'll need an executor to drive `Future` returned
//! from `Server::run()`. `async-std` and `tokio` are two popular options. In `counter` example, we use `async-std`'s
//! executor.
//!
//! To know more, go to `examples/` to see a sample ABCI application.
//!
Expand Down
2 changes: 1 addition & 1 deletion src/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ where
///
/// # Note
///
/// This is an `async` function and returns a `Future`. So, you'll need an executor to run the `Future` returned
/// This is an `async` function and returns a `Future`. So, you'll need an executor to drive the `Future` returned
/// from this function. `async-std` and `tokio` are two popular options.
pub async fn run<T>(&self, addr: T) -> Result<()>
where
Expand Down

0 comments on commit 86f8c05

Please sign in to comment.