Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
devashishdxt committed Nov 13, 2019
1 parent f9e54b2 commit a7b35ca
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ where
}

/// Starts ABCI server
///
/// # Note
///
/// This is an `async` function and returns a `Future`. So, you'll need an executor to run the `Future` returned
/// from this function. `async-std` and `tokio` are two popular options.
pub async fn run<T>(&self, addr: T) -> Result<()>
where
T: Into<Address>,
Expand Down

0 comments on commit a7b35ca

Please sign in to comment.