Skip to content

Commit ea939eb

Browse files
committed
Minor docs improvements
1 parent c728d68 commit ea939eb

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## NEXT
66
***
77
**⭐️ New Features**
8-
- Add Support for Bolt 6.0: vector types.
8+
- Add Support for Bolt 6.0: vector types & unsupported type.
99

1010
**👏️ Improvements**
1111
- Reduce network latency in some cases by setting `TCP_NODELAY`.

neo4j/src/driver/session/bookmarks.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ pub trait BookmarkManager: Debug + Send + Sync {
246246
/// Provide the bookmarks to be used for the next transaction.
247247
///
248248
/// Before staring work configured with with bookmark manager, the driver will call this method
249-
/// to get the bookmarks to.
249+
/// to get the bookmarks to be sent to the server.
250250
///
251251
/// If the method fails, the driver will return [`Neo4jError::UserCallback`] with
252252
/// [`UserCallbackError::BookmarkManagerGet`].

neo4j/src/lib.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125
//! ### Main Mechanisms for Query Execution
126126
//! There are three main ways to execute queries:
127127
//! - [`Driver::execute_query()`] is the easiest way to run a query.
128-
//! Prefer it whenever possible as it most efficient.
128+
//! Prefer it whenever possible as it's most efficient.
129129
//! - [`Session::transaction()`] gives you full control over the transaction.
130130
//! - [`Session::auto_commit()`] is a special method for running queries that manage their own
131131
//! transactions, such as `CALL {...} IN TRANSACTION`.
@@ -137,9 +137,9 @@
137137
//! To provide stronger guarantees, the server sends a bookmark to the client after every
138138
//! successful transaction that applies a write.
139139
//! These bookmarks are abstract tokens that represent some state of the database.
140-
//! By passing them back to the server along with a transaction, the client requests the server to
141-
//! wait until the state(s) represented by the bookmark(s) have been established before executing
142-
//! the transaction.
140+
//! By passing them back to the server when starting a transaction, the client requests the server to
141+
//! wait until the state(s) represented by the bookmark(s) have been established before beginning
142+
//! said transaction.
143143
//!
144144
//! To point out the obvious: relying on bookmarks can be slow because of the wait described above.
145145
//! Not using them, however, can lead to stale reads which will be unacceptable in some cases.

0 commit comments

Comments
 (0)