Skip to content

Commit 104509f

Browse files
committed
Nit fixes
Signed-off-by: Ana Hobden <operator@hoverbear.org>
1 parent 9d9b2cc commit 104509f

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
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 (e.g. 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 to help us find problems!
77
8-
This crate provides Rust bindings to [TiKV](https://github.com/tikv/tikv), a distributed transactional Key-Value database written in Rust.
8+
This crate provides a clean, ready to use client for [TiKV](https://github.com/tikv/tikv), a
9+
distributed transactional Key-Value database written in Rust.
910

1011
With this crate you can easily connect to any TiKV deployment, interact with it, and mutate the data it contains.
1112

@@ -25,13 +26,14 @@ tikv-client = "~0.1"
2526

2627
## Access the documentation
2728

28-
We recommend using the autogenerated to browse and understand the API. We've done our best to include ample, tested, and understandable examples.
29+
We recommend using the cargo-generated documentation to browse and understand the API. We've done
30+
our best to include ample, tested, and understandable examples.
31+
32+
You can visit [docs.rs/tikv-client](https://docs.rs/tikv-client/), or build the documentation yourself.
2933

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

3236
```bash
3337
cargo doc --package tikv-client --open
3438
# If it didn't work, browse file URL it tried to open with your browser.
3539
```
36-
37-
Otherwise, you can visit [docs.rs/tikv-client](https://docs.rs/tikv-client/).

src/lib.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
//! > in active development. You're encouraged to use this library for testing and help us find
2020
//! > problems!
2121
//!
22-
//! This crate provides Rust bindings to [TiKV](https://github.com/tikv/tikv), a distributed
23-
//! transactional Key-Value database written in Rust.
22+
//! This crate provides a clean, ready to use client for [TiKV](https://github.com/tikv/tikv), a
23+
//! distributed transactional Key-Value database written in Rust.
2424
//!
2525
//! With this crate you can easily connect to any TiKV deployment, interact with it, and mutate the
2626
//! data it contains.
@@ -52,8 +52,8 @@
5252
//! This crate offers both [**raw**](raw/index.html) and
5353
//! [**transactional**](transaction/index.html) APIs. You should choose just one for your system.
5454
//!
55-
//! The *consequence* of supporting transactions is increased overhead of coordination with `pd`
56-
//! for timestamp acquisition. This is approximately 1 RTT.
55+
//! The *consequence* of supporting transactions is increased overhead of coordination with the
56+
//! placement driver for timestamp acquisition. This is approximately 1 RTT.
5757
//!
5858
//! *While it is possible to use both APIs at the same time, doing so is unsafe and unsupported.*
5959
//!
@@ -62,7 +62,7 @@
6262
//!
6363
//! ### Transactional
6464
//!
65-
//! The [transactional](transaction/index.html) API supports **transactions** via Multi-View
65+
//! The [transactional](transaction/index.html) API supports **transactions** via Multi-Version
6666
//! Concurrency Control (MVCC).
6767
//!
6868
//! **Best when you mostly do** complex sets of actions, actions which may require a rollback,
@@ -78,7 +78,7 @@
7878
//! transactional abilities.
7979
//!
8080
//! **Best when you mostly do** single row changes, and have very limited cross-row (eg. foreign
81-
//! key) requirements.
81+
//! key) requirements. You will not be able to use transactions with this API.
8282
//!
8383
//! ```rust
8484
//! use tikv_client::{*, raw::*};

0 commit comments

Comments
 (0)