Skip to content

Commit

Permalink
Merge pull request #175 from AureliaDolo/typos
Browse files Browse the repository at this point in the history
Fix typos.
  • Loading branch information
Kerollmops committed Jul 5, 2023
2 parents c6179eb + 74738ac commit 6be994d
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ cd heed
cargo build
```

However, if you already cloned it and forgot about the initialising the submodules:
However, if you already cloned it and forgot about the initializing the submodules:

```bash
git submodule update --init
Expand Down
16 changes: 8 additions & 8 deletions heed-types/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
//! But if you want to store big types that can be efficiently deserialized then
//! here is a little table to help you in your quest:
//!
//! | Available types | Encoding type | Decoding type | allocations |
//! |--------------------|:-------------:|:-------------:|----------------------------------------------------------|
//! | [`CowSlice`] | `&[T]` | `Cow<[T]>` | will allocate if memory is miss-aligned |
//! | [`CowType`] | `&T` | `Cow<T>` | will allocate if memory is miss-aligned |
//! | [`OwnedSlice`] | `&[T]` | `Vec<T>` | will _always_ allocate |
//! | [`OwnedType`] | `&T` | `T` | will _always_ allocate |
//! | [`UnalignedSlice`] | `&[T]` | `&[T]` | will _never_ allocate because alignement is always valid |
//! | [`UnalignedType`] | `&T` | `&T` | will _never_ allocate because alignement is always valid |
//! | Available types | Encoding type | Decoding type | allocations |
//! |--------------------|:-------------:|:-------------:|---------------------------------------------------------|
//! | [`CowSlice`] | `&[T]` | `Cow<[T]>` | will allocate if memory is miss-aligned |
//! | [`CowType`] | `&T` | `Cow<T>` | will allocate if memory is miss-aligned |
//! | [`OwnedSlice`] | `&[T]` | `Vec<T>` | will _always_ allocate |
//! | [`OwnedType`] | `&T` | `T` | will _always_ allocate |
//! | [`UnalignedSlice`] | `&[T]` | `&[T]` | will _never_ allocate because alignment is always valid |
//! | [`UnalignedType`] | `&T` | `&T` | will _never_ allocate because alignment is always valid |
//!
//! [`Serialize`]: serde::Serialize
//! [`Deserialize`]: serde::Deserialize
Expand Down
4 changes: 2 additions & 2 deletions heed/src/cursor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ impl<'txn> RwCursor<'txn> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down Expand Up @@ -310,7 +310,7 @@ impl<'txn> RwCursor<'txn> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down
4 changes: 2 additions & 2 deletions heed/src/db/polymorph.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1699,7 +1699,7 @@ impl PolyDatabase {

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

/// Deletes all key/value pairs in this database.
///
/// Perfer using this method instead of a call to [`delete_range`] with a full range ([`..`]).
/// Prefer using this method instead of a call to [`delete_range`] with a full range ([`..`]).
///
/// [`delete_range`]: crate::Database::delete_range
/// [`..`]: std::ops::RangeFull
Expand Down
4 changes: 2 additions & 2 deletions heed/src/db/uniform.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1395,7 +1395,7 @@ impl<KC, DC> Database<KC, DC> {

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

/// Deletes all key/value pairs in this database.
///
/// Perfer using this method instead of a call to [`delete_range`] with a full range ([`..`]).
/// Prefer using this method instead of a call to [`delete_range`] with a full range ([`..`]).
///
/// [`delete_range`]: crate::Database::delete_range
/// [`..`]: std::ops::RangeFull
Expand Down
6 changes: 3 additions & 3 deletions heed/src/iter/iter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ impl<'txn, KC, DC> RwIter<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down Expand Up @@ -193,7 +193,7 @@ impl<'txn, KC, DC> RwIter<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down Expand Up @@ -415,7 +415,7 @@ impl<'txn, KC, DC> RwRevIter<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down
8 changes: 4 additions & 4 deletions heed/src/iter/prefix.rs
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ impl<'txn, KC, DC> RwPrefix<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down Expand Up @@ -220,7 +220,7 @@ impl<'txn, KC, DC> RwPrefix<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down Expand Up @@ -472,7 +472,7 @@ impl<'txn, KC, DC> RwRevPrefix<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down Expand Up @@ -531,7 +531,7 @@ impl<'txn, KC, DC> RwRevPrefix<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down
8 changes: 4 additions & 4 deletions heed/src/iter/range.rs
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ impl<'txn, KC, DC> RwRange<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down Expand Up @@ -278,7 +278,7 @@ impl<'txn, KC, DC> RwRange<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down Expand Up @@ -578,7 +578,7 @@ impl<'txn, KC, DC> RwRevRange<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down Expand Up @@ -637,7 +637,7 @@ impl<'txn, KC, DC> RwRevRange<'txn, KC, DC> {
/// modifying it, so you can't use the key/value that comes from the cursor to feed
/// this function.
///
/// In other words: Tranform the key and value that you borrow from this database into an owned
/// In other words: Transform the key and value that you borrow from this database into an owned
/// version of them i.e. `&str` into `String`.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
Expand Down
4 changes: 2 additions & 2 deletions heed/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
//! let dir = tempfile::tempdir()?;
//! let env = EnvOpenOptions::new().open(dir.path())?;
//!
//! // we will open the default unamed database
//! // we will open the default unnamed database
//! let mut wtxn = env.write_txn()?;
//! let db: Database<Str, OwnedType<i32>> = env.create_database(&mut wtxn, None)?;
//!
Expand Down Expand Up @@ -86,7 +86,7 @@ pub enum Error {
InvalidDatabaseTyping,
DatabaseClosing,
BadOpenOptions {
/// The options that were used to originaly open this env.
/// The options that were used to originally open this env.
options: EnvOpenOptions,
/// The env opened with the original options.
env: Env,
Expand Down

0 comments on commit 6be994d

Please sign in to comment.