Skip to content

Commit 43fa973

Browse files
committed
Apply suggestions from code review
Nit fixes. Signed-off-by: Ana Hobden <operator@hoverbear.org>
1 parent 1f78fca commit 43fa973

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Build Status](https://travis-ci.org/tikv/client-rust.svg?branch=master)](https://travis-ci.org/pingcap/client-rust)
44
[![Documentation](https://docs.rs/tikv-client/badge.svg)](https://docs.rs/tikv-client/)
55

6-
> Currently this crate is experimental and some portions (eg the Transactional API) are still in active development. You're encouraged to use this library for testing and help us find problems!
6+
> Currently this crate is experimental and some portions (e.g. the Transactional API) are still in active development. You're encouraged to use this library for testing and help us find problems!
77
88
This crate provides Rust bindings to [TiKV](https://github.com/tikv/tikv), a distributed transactional Key-Value database written in Rust.
99

@@ -15,7 +15,7 @@ This is an open source (Apache 2) project hosted by the Cloud Native Computing F
1515

1616
There are no special requirements to use this. It is a Rust 2018 edition crate supporting stable and nightly.
1717

18-
To use this crate in your project, depend on it in the `Cargo.toml` of your Rust project:
18+
To use this crate in your project, add it as a dependency in the `Cargo.toml` of your Rust project:
1919

2020
```toml
2121
[dependencies]
@@ -25,7 +25,7 @@ tikv-client = "~0.1"
2525

2626
## Access the documentation
2727

28-
We reccomend using the autogenerated to browse and understand the API. We've done our best to include ample, tested, and understandable examples.
28+
We recommend using the autogenerated to browse and understand the API. We've done our best to include ample, tested, and understandable examples.
2929

3030
You can access the documentation on your machine by running the following in any project that depends on `tikv-client`.
3131

src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
//! There are no special requirements to use this. It is a Rust 2018 edition crate supporting
3535
//! stable and nightly.
3636
//!
37-
//! To use this crate in your project, depend on it in the `Cargo.toml` of your Rust project:
37+
//! To use this crate in your project, add it as a dependency in the `Cargo.toml` of your Rust project:
3838
//!
3939
//! ```toml
4040
//! [dependencies]
@@ -43,7 +43,7 @@
4343
//! futures = "0.1" # You'll need this later.
4444
//! ```
4545
//!
46-
//! Then give a `cargo build --package tikv-client` to test building the crate.
46+
//! Then run a `cargo build --package tikv-client` command to test building the crate.
4747
//!
4848
//! Next, you need to choose the API appropriate for your needs.
4949
//!

src/raw.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
//! This interface offers optimal performance as it does not require coordination with a timestamp
1919
//! oracle, while the transactional interface does.
2020
//!
21-
//! **Warning:** It is not advisible to use the both raw and transactional functionality in the same keyspace.
21+
//! **Warning:** It is not advisable to use both raw and transactional functionality in the same keyspace.
2222
//!
2323
use crate::{rpc::RpcClient, Config, Error, Key, KeyRange, KvFuture, KvPair, Result, Value};
2424
use futures::{future, Async, Future, Poll};

src/transaction.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
//!
1818
//! This interface offers SQL-like transactions on top of the raw interface.
1919
//!
20-
//! **Warning:** It is not advisible to use the both raw and transactional functionality in the same keyspace.
20+
//! **Warning:** It is not advisable to use both raw and transactional functionality in the same keyspace.
2121
//!
2222
2323
use crate::{Config, Error, Key, KvPair, Value};

0 commit comments

Comments
 (0)