Skip to content

Commit 6be994d

Browse files
authored
Merge pull request #175 from AureliaDolo/typos
Fix typos.
2 parents c6179eb + 74738ac commit 6be994d

File tree

9 files changed

+28
-28
lines changed

9 files changed

+28
-28
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ cd heed
2525
cargo build
2626
```
2727

28-
However, if you already cloned it and forgot about the initialising the submodules:
28+
However, if you already cloned it and forgot about the initializing the submodules:
2929

3030
```bash
3131
git submodule update --init

heed-types/src/lib.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99
//! But if you want to store big types that can be efficiently deserialized then
1010
//! here is a little table to help you in your quest:
1111
//!
12-
//! | Available types | Encoding type | Decoding type | allocations |
13-
//! |--------------------|:-------------:|:-------------:|----------------------------------------------------------|
14-
//! | [`CowSlice`] | `&[T]` | `Cow<[T]>` | will allocate if memory is miss-aligned |
15-
//! | [`CowType`] | `&T` | `Cow<T>` | will allocate if memory is miss-aligned |
16-
//! | [`OwnedSlice`] | `&[T]` | `Vec<T>` | will _always_ allocate |
17-
//! | [`OwnedType`] | `&T` | `T` | will _always_ allocate |
18-
//! | [`UnalignedSlice`] | `&[T]` | `&[T]` | will _never_ allocate because alignement is always valid |
19-
//! | [`UnalignedType`] | `&T` | `&T` | will _never_ allocate because alignement is always valid |
12+
//! | Available types | Encoding type | Decoding type | allocations |
13+
//! |--------------------|:-------------:|:-------------:|---------------------------------------------------------|
14+
//! | [`CowSlice`] | `&[T]` | `Cow<[T]>` | will allocate if memory is miss-aligned |
15+
//! | [`CowType`] | `&T` | `Cow<T>` | will allocate if memory is miss-aligned |
16+
//! | [`OwnedSlice`] | `&[T]` | `Vec<T>` | will _always_ allocate |
17+
//! | [`OwnedType`] | `&T` | `T` | will _always_ allocate |
18+
//! | [`UnalignedSlice`] | `&[T]` | `&[T]` | will _never_ allocate because alignment is always valid |
19+
//! | [`UnalignedType`] | `&T` | `&T` | will _never_ allocate because alignment is always valid |
2020
//!
2121
//! [`Serialize`]: serde::Serialize
2222
//! [`Deserialize`]: serde::Deserialize

heed/src/cursor.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ impl<'txn> RwCursor<'txn> {
228228
/// modifying it, so you can't use the key/value that comes from the cursor to feed
229229
/// this function.
230230
///
231-
/// In other words: Tranform the key and value that you borrow from this database into an owned
231+
/// In other words: Transform the key and value that you borrow from this database into an owned
232232
/// version of them i.e. `&str` into `String`.
233233
///
234234
/// > [Values returned from the database are valid only until a subsequent update operation,
@@ -310,7 +310,7 @@ impl<'txn> RwCursor<'txn> {
310310
/// modifying it, so you can't use the key/value that comes from the cursor to feed
311311
/// this function.
312312
///
313-
/// In other words: Tranform the key and value that you borrow from this database into an owned
313+
/// In other words: Transform the key and value that you borrow from this database into an owned
314314
/// version of them i.e. `&str` into `String`.
315315
///
316316
/// > [Values returned from the database are valid only until a subsequent update operation,

heed/src/db/polymorph.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1699,7 +1699,7 @@ impl PolyDatabase {
16991699

17001700
/// Deletes a range of key-value pairs in this database.
17011701
///
1702-
/// Perfer using [`clear`] instead of a call to this method with a full range ([`..`]).
1702+
/// Prefer using [`clear`] instead of a call to this method with a full range ([`..`]).
17031703
///
17041704
/// Comparisons are made by using the bytes representation of the key.
17051705
///
@@ -1767,7 +1767,7 @@ impl PolyDatabase {
17671767

17681768
/// Deletes all key/value pairs in this database.
17691769
///
1770-
/// Perfer using this method instead of a call to [`delete_range`] with a full range ([`..`]).
1770+
/// Prefer using this method instead of a call to [`delete_range`] with a full range ([`..`]).
17711771
///
17721772
/// [`delete_range`]: crate::Database::delete_range
17731773
/// [`..`]: std::ops::RangeFull

heed/src/db/uniform.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1395,7 +1395,7 @@ impl<KC, DC> Database<KC, DC> {
13951395

13961396
/// Deletes a range of key-value pairs in this database.
13971397
///
1398-
/// Perfer using [`clear`] instead of a call to this method with a full range ([`..`]).
1398+
/// Prefer using [`clear`] instead of a call to this method with a full range ([`..`]).
13991399
///
14001400
/// Comparisons are made by using the bytes representation of the key.
14011401
///
@@ -1451,7 +1451,7 @@ impl<KC, DC> Database<KC, DC> {
14511451

14521452
/// Deletes all key/value pairs in this database.
14531453
///
1454-
/// Perfer using this method instead of a call to [`delete_range`] with a full range ([`..`]).
1454+
/// Prefer using this method instead of a call to [`delete_range`] with a full range ([`..`]).
14551455
///
14561456
/// [`delete_range`]: crate::Database::delete_range
14571457
/// [`..`]: std::ops::RangeFull

heed/src/iter/iter.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ impl<'txn, KC, DC> RwIter<'txn, KC, DC> {
134134
/// modifying it, so you can't use the key/value that comes from the cursor to feed
135135
/// this function.
136136
///
137-
/// In other words: Tranform the key and value that you borrow from this database into an owned
137+
/// In other words: Transform the key and value that you borrow from this database into an owned
138138
/// version of them i.e. `&str` into `String`.
139139
///
140140
/// > [Values returned from the database are valid only until a subsequent update operation,
@@ -193,7 +193,7 @@ impl<'txn, KC, DC> RwIter<'txn, KC, DC> {
193193
/// modifying it, so you can't use the key/value that comes from the cursor to feed
194194
/// this function.
195195
///
196-
/// In other words: Tranform the key and value that you borrow from this database into an owned
196+
/// In other words: Transform the key and value that you borrow from this database into an owned
197197
/// version of them i.e. `&str` into `String`.
198198
///
199199
/// > [Values returned from the database are valid only until a subsequent update operation,
@@ -415,7 +415,7 @@ impl<'txn, KC, DC> RwRevIter<'txn, KC, DC> {
415415
/// modifying it, so you can't use the key/value that comes from the cursor to feed
416416
/// this function.
417417
///
418-
/// In other words: Tranform the key and value that you borrow from this database into an owned
418+
/// In other words: Transform the key and value that you borrow from this database into an owned
419419
/// version of them i.e. `&str` into `String`.
420420
///
421421
/// > [Values returned from the database are valid only until a subsequent update operation,

heed/src/iter/prefix.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ impl<'txn, KC, DC> RwPrefix<'txn, KC, DC> {
161161
/// modifying it, so you can't use the key/value that comes from the cursor to feed
162162
/// this function.
163163
///
164-
/// In other words: Tranform the key and value that you borrow from this database into an owned
164+
/// In other words: Transform the key and value that you borrow from this database into an owned
165165
/// version of them i.e. `&str` into `String`.
166166
///
167167
/// > [Values returned from the database are valid only until a subsequent update operation,
@@ -220,7 +220,7 @@ impl<'txn, KC, DC> RwPrefix<'txn, KC, DC> {
220220
/// modifying it, so you can't use the key/value that comes from the cursor to feed
221221
/// this function.
222222
///
223-
/// In other words: Tranform the key and value that you borrow from this database into an owned
223+
/// In other words: Transform the key and value that you borrow from this database into an owned
224224
/// version of them i.e. `&str` into `String`.
225225
///
226226
/// > [Values returned from the database are valid only until a subsequent update operation,
@@ -472,7 +472,7 @@ impl<'txn, KC, DC> RwRevPrefix<'txn, KC, DC> {
472472
/// modifying it, so you can't use the key/value that comes from the cursor to feed
473473
/// this function.
474474
///
475-
/// In other words: Tranform the key and value that you borrow from this database into an owned
475+
/// In other words: Transform the key and value that you borrow from this database into an owned
476476
/// version of them i.e. `&str` into `String`.
477477
///
478478
/// > [Values returned from the database are valid only until a subsequent update operation,
@@ -531,7 +531,7 @@ impl<'txn, KC, DC> RwRevPrefix<'txn, KC, DC> {
531531
/// modifying it, so you can't use the key/value that comes from the cursor to feed
532532
/// this function.
533533
///
534-
/// In other words: Tranform the key and value that you borrow from this database into an owned
534+
/// In other words: Transform the key and value that you borrow from this database into an owned
535535
/// version of them i.e. `&str` into `String`.
536536
///
537537
/// > [Values returned from the database are valid only until a subsequent update operation,

heed/src/iter/range.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ impl<'txn, KC, DC> RwRange<'txn, KC, DC> {
219219
/// modifying it, so you can't use the key/value that comes from the cursor to feed
220220
/// this function.
221221
///
222-
/// In other words: Tranform the key and value that you borrow from this database into an owned
222+
/// In other words: Transform the key and value that you borrow from this database into an owned
223223
/// version of them i.e. `&str` into `String`.
224224
///
225225
/// > [Values returned from the database are valid only until a subsequent update operation,
@@ -278,7 +278,7 @@ impl<'txn, KC, DC> RwRange<'txn, KC, DC> {
278278
/// modifying it, so you can't use the key/value that comes from the cursor to feed
279279
/// this function.
280280
///
281-
/// In other words: Tranform the key and value that you borrow from this database into an owned
281+
/// In other words: Transform the key and value that you borrow from this database into an owned
282282
/// version of them i.e. `&str` into `String`.
283283
///
284284
/// > [Values returned from the database are valid only until a subsequent update operation,
@@ -578,7 +578,7 @@ impl<'txn, KC, DC> RwRevRange<'txn, KC, DC> {
578578
/// modifying it, so you can't use the key/value that comes from the cursor to feed
579579
/// this function.
580580
///
581-
/// In other words: Tranform the key and value that you borrow from this database into an owned
581+
/// In other words: Transform the key and value that you borrow from this database into an owned
582582
/// version of them i.e. `&str` into `String`.
583583
///
584584
/// > [Values returned from the database are valid only until a subsequent update operation,
@@ -637,7 +637,7 @@ impl<'txn, KC, DC> RwRevRange<'txn, KC, DC> {
637637
/// modifying it, so you can't use the key/value that comes from the cursor to feed
638638
/// this function.
639639
///
640-
/// In other words: Tranform the key and value that you borrow from this database into an owned
640+
/// In other words: Transform the key and value that you borrow from this database into an owned
641641
/// version of them i.e. `&str` into `String`.
642642
///
643643
/// > [Values returned from the database are valid only until a subsequent update operation,

heed/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
//! let dir = tempfile::tempdir()?;
2525
//! let env = EnvOpenOptions::new().open(dir.path())?;
2626
//!
27-
//! // we will open the default unamed database
27+
//! // we will open the default unnamed database
2828
//! let mut wtxn = env.write_txn()?;
2929
//! let db: Database<Str, OwnedType<i32>> = env.create_database(&mut wtxn, None)?;
3030
//!
@@ -86,7 +86,7 @@ pub enum Error {
8686
InvalidDatabaseTyping,
8787
DatabaseClosing,
8888
BadOpenOptions {
89-
/// The options that were used to originaly open this env.
89+
/// The options that were used to originally open this env.
9090
options: EnvOpenOptions,
9191
/// The env opened with the original options.
9292
env: Env,

0 commit comments

Comments
 (0)