refactor: rename to reqd_confs #353
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
prestwich
requested review from
DaniPopes,
gakonst,
mattsse and
onbjerg
as code owners
DaniPopes
approved these changes
Mar 21, 2024
DaniPopes
reviewed
Mar 21, 2024
crates/provider/src/heart.rs
Outdated
| @@ -108,18 +108,18 @@ impl<'a, N: Network, T: Transport + Clone> PendingTransactionBuilder<'a, N, T> { | |||
| } | |||
|
|
|||
| /// Returns the number of confirmations to wait for. | |||
| pub const fn confirmations(&self) -> u64 { | |||
| self.config.confirmations() | |||
| pub const fn reqd_confs(&self) -> u64 { | |||
There was a problem hiding this comment.
maybe #[doc(alias = "confirmations")] on at least one of these for discoverability?
There was a problem hiding this comment.
I'll go ahead and alias them all 👍
prestwich
force-pushed
the
prestwich/reqd-confs
branch
from
35c955a
to
1009bca
Compare
mattsse
reviewed
Mar 21, 2024
| @@ -108,18 +108,21 @@ impl<'a, N: Network, T: Transport + Clone> PendingTransactionBuilder<'a, N, T> { | |||
| } | |||
|
|
|||
| /// Returns the number of confirmations to wait for. | |||
There was a problem hiding this comment.
Suggested change
| /// Returns the number of confirmations to wait for. | |
| /// Returns the number of required confirmations to wait for. |
or is this requested?
I also wouldn't mind if we use fn required_confirmations
There was a problem hiding this comment.
I don't mind any particular name. I suppose this gets used most often in new-lined builder patterns where fn name lenght is not a primary concern. so that means longer and clearer is better
onbjerg
approved these changes
Mar 21, 2024
mattsse
approved these changes
Mar 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Clarify naming on pending transaction and associated structs
Solution
rename
confirmationstoreqd_confsPR Checklist