Skip to content

Conversation

@realeinherjar
Copy link
Contributor

More typos fix before #1165

Changelog notice

Fix more typos in the docs

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

New Features:

  • I've added tests for the new feature
  • I've added docs for the new feature

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

More typos fix before bitcoindevkit#1165
@notmandatory notmandatory added the documentation Improvements or additions to documentation label Nov 17, 2023
@notmandatory
Copy link
Member

I moved this to the beta milestone so we can collect more typo fixes if they come up here.

@realeinherjar
Copy link
Contributor Author

This is ready to merge and it is a block for #1165

@ValuedMammal
Copy link
Collaborator

looks like in #1220 this got corrected to 'should' instead of 'could'

/// Defaults to `false` to mitigate the "SegWit bug" which should trick the wallet into
/// paying a fee larger than expected.

@ValuedMammal
Copy link
Collaborator

/// Remaining amount after deducing fees and outgoing outputs
pub excess: Excess,

deducing -> deducting

@ValuedMammal
Copy link
Collaborator

after #1178 the doc for ‎Store::aggregate_changesets is stale.

/// Loads all the changesets that have been stored as one giant changeset.
///
/// This function returns a tuple of the aggregate changeset and a result that indicates
/// whether an error occurred while reading or deserializing one of the entries. If so the
/// changeset will consist of all of those it was able to read.

it could say something like

/// This function returns the aggregate changeset, which may be `None` if nothing 
/// was persisted. If reading or deserializing any of the entries fails, an error is 
/// returned that includes all those it was able to read.

@storopoli
Copy link
Contributor

We can close this

@evanlinjin evanlinjin closed this Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants