Polish documentation of transaction

Signed-off-by: Nick Cameron <[email protected]>
joker53-1 · Apr 22, 2021 · 87e091d · 87e091d
1 parent 5b91ab9
commit 87e091d
Show file tree

Hide file tree

Showing 2 changed files with 121 additions and 73 deletions.
diff --git a/src/transaction/client.rs b/src/transaction/client.rs
@@ -46,8 +46,8 @@ impl Client {
  /// # Examples
  ///
  /// ```rust,no_run
- /// use tikv_client::{Config, TransactionClient};
- /// use futures::prelude::*;
+ /// # use tikv_client::{Config, TransactionClient};
+ /// # use futures::prelude::*;
  /// # futures::executor::block_on(async {
  /// let client = TransactionClient::new(vec!["192.168.0.100"]).await.unwrap();
  /// # });
@@ -65,8 +65,9 @@ impl Client {
  /// # Examples
  ///
  /// ```rust,no_run
- /// use tikv_client::{Config, TransactionClient};
- /// use futures::prelude::*;
+ /// # use tikv_client::{Config, TransactionClient};
+ /// # use futures::prelude::*;
+ /// # use std::time::Duration;
  /// # futures::executor::block_on(async {
  /// let client = TransactionClient::new_with_config(
  /// vec!["192.168.0.100"],
@@ -94,8 +95,8 @@ impl Client {
  /// # Examples
  ///
  /// ```rust,no_run
- /// use tikv_client::{Config, TransactionClient};
- /// use futures::prelude::*;
+ /// # use tikv_client::{Config, TransactionClient};
+ /// # use futures::prelude::*;
  /// # futures::executor::block_on(async {
  /// let client = TransactionClient::new(vec!["192.168.0.100"]).await.unwrap();
  /// let mut transaction = client.begin_optimistic().await.unwrap();
@@ -116,8 +117,8 @@ impl Client {
  /// # Examples
  ///
  /// ```rust,no_run
- /// use tikv_client::{Config, TransactionClient};
- /// use futures::prelude::*;
+ /// # use tikv_client::{Config, TransactionClient};
+ /// # use futures::prelude::*;
  /// # futures::executor::block_on(async {
  /// let client = TransactionClient::new(vec!["192.168.0.100"]).await.unwrap();
  /// let mut transaction = client.begin_pessimistic().await.unwrap();
@@ -135,8 +136,8 @@ impl Client {
  /// # Examples
  ///
  /// ```rust,no_run
- /// use tikv_client::{Config, TransactionClient, TransactionOptions};
- /// use futures::prelude::*;
+ /// # use tikv_client::{Config, TransactionClient, TransactionOptions};
+ /// # use futures::prelude::*;
  /// # futures::executor::block_on(async {
  /// let client = TransactionClient::new(vec!["192.168.0.100"]).await.unwrap();
  /// let mut transaction = client
@@ -162,8 +163,8 @@ impl Client {
  /// # Examples
  ///
  /// ```rust,no_run
- /// use tikv_client::{Config, TransactionClient};
- /// use futures::prelude::*;
+ /// # use tikv_client::{Config, TransactionClient};
+ /// # use futures::prelude::*;
  /// # futures::executor::block_on(async {
  /// let client = TransactionClient::new(vec!["192.168.0.100"]).await.unwrap();
  /// let timestamp = client.current_timestamp().await.unwrap();