Skip to content

Commit 9f9ffd0

Browse files
committed
Merge #703: Fix minor typos in docs
134b19a Fix minor typos in docs (thunderbiscuit) Pull request description: ### Description This PR fixes: 1. The use of "i.e." in docs, sometimes spelled as "ie." 2. A small typo in the sentence "Note that this methods only operate on the internal database..." 3. A small typo in the sentence "Finish the building the transaction" I came across these while building docs for bdk-kotlin. ### Notes to the reviewers ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I ran `cargo fmt` and `cargo clippy` before committing ACKs for top commit: danielabrozzoni: ACK 134b19a Tree-SHA512: 67296999eba8ffe1fe64756fa023d85064774cb9d4c26e99054d467b5024baea4138f11d602d04e695412c61625ee4f5b4687b75f177cfec2604a6c61a5a6216
2 parents d9adfbe + 134b19a commit 9f9ffd0

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4545

4646
## [v0.18.0] - [v0.17.0]
4747

48-
- Add `sqlite-bundled` feature for deployments that need a bundled version of sqlite, ie. for mobile platforms.
48+
- Add `sqlite-bundled` feature for deployments that need a bundled version of sqlite, i.e. for mobile platforms.
4949
- Added `Wallet::get_signers()`, `Wallet::descriptor_checksum()` and `Wallet::get_address_validators()`, exposed the `AsDerived` trait.
5050
- Deprecate `database::Database::flush()`, the function is only needed for the sled database on mobile, instead for mobile use the sqlite database.
5151
- Add `keychain: KeychainKind` to `wallet::AddressInfo`.

DEVELOPMENT_CYCLE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Pre-`v1.0.0` our "major" releases only affect the "minor" semver value. Accordin
3939
11. Publish **all** the updated crates to crates.io.
4040
12. Make a new commit to bump the version value to `x.y.(z+1)-dev`. The message should be "Bump version to x.y.(z+1)-dev".
4141
13. Merge the release branch back into `master`.
42-
14. If the `master` branch contains any unreleased changes to the `bdk-macros` crate, change the `bdk` Cargo.toml `[dependencies]` to point to the local path (ie. `bdk-macros = { path = "./macros"}`)
42+
14. If the `master` branch contains any unreleased changes to the `bdk-macros` crate, change the `bdk` Cargo.toml `[dependencies]` to point to the local path (i.e. `bdk-macros = { path = "./macros"}`)
4343
15. Create the release on GitHub: go to "tags", click on the dots on the right and select "Create Release". Then set the title to `vx.y.z` and write down some brief release notes.
4444
16. Make sure the new release shows up on crates.io and that the docs are built correctly on docs.rs.
4545
17. Announce the release on Twitter, Discord and Telegram.

src/descriptor/dsl.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -839,7 +839,7 @@ mod test {
839839
}
840840
}
841841

842-
// - at least one of each "type" of operator; ie. one modifier, one leaf_opcode, one leaf_opcode_value, etc.
842+
// - at least one of each "type" of operator; i.e. one modifier, one leaf_opcode, one leaf_opcode_value, etc.
843843
// - mixing up key types that implement IntoDescriptorKey in multi() or thresh()
844844

845845
// expected script for pk and bare manually created

src/wallet/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ where
325325

326326
/// Return a derived address using the external descriptor, see [`AddressIndex`] for
327327
/// available address index selection strategies. If none of the keys in the descriptor are derivable
328-
/// (ie. does not end with /*) then the same address will always be returned for any [`AddressIndex`].
328+
/// (i.e. does not end with /*) then the same address will always be returned for any [`AddressIndex`].
329329
pub fn get_address(&self, address_index: AddressIndex) -> Result<AddressInfo, Error> {
330330
self._get_address(address_index, KeychainKind::External)
331331
}
@@ -335,7 +335,7 @@ where
335335
/// If the wallet doesn't have an internal descriptor it will use the external descriptor.
336336
///
337337
/// see [`AddressIndex`] for available address index selection strategies. If none of the keys
338-
/// in the descriptor are derivable (ie. does not end with /*) then the same address will always
338+
/// in the descriptor are derivable (i.e. does not end with /*) then the same address will always
339339
/// be returned for any [`AddressIndex`].
340340
pub fn get_internal_address(&self, address_index: AddressIndex) -> Result<AddressInfo, Error> {
341341
self._get_address(address_index, KeychainKind::Internal)
@@ -454,7 +454,7 @@ where
454454
/// });
455455
/// ```
456456
///
457-
/// Note that this methods only operate on the internal database, which first needs to be
457+
/// Note that this method only operates on the internal database, which first needs to be
458458
/// [`Wallet::sync`] manually.
459459
pub fn list_transactions(&self, include_raw: bool) -> Result<Vec<TransactionDetails>, Error> {
460460
self.database.borrow().iter_txs(include_raw)
@@ -463,7 +463,7 @@ where
463463
/// Return the balance, separated into available, trusted-pending, untrusted-pending and immature
464464
/// values.
465465
///
466-
/// Note that this methods only operate on the internal database, which first needs to be
466+
/// Note that this method only operates on the internal database, which first needs to be
467467
/// [`Wallet::sync`] manually.
468468
pub fn get_balance(&self) -> Result<Balance, Error> {
469469
let mut immature = 0;

src/wallet/tx_builder.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ impl<'a, D: BatchDatabase, Cs: CoinSelectionAlgorithm<D>, Ctx: TxBuilderContext>
516516
}
517517
}
518518

519-
/// Finish the building the transaction.
519+
/// Finish building the transaction.
520520
///
521521
/// Returns the [`BIP174`] "PSBT" and summary details about the transaction.
522522
///

0 commit comments

Comments
 (0)