Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(mempool): add docstring for queued transaction #416

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

MohammadNassar1
Copy link
Contributor

@MohammadNassar1 MohammadNassar1 commented Jul 9, 2024

This change is Reviewable

@MohammadNassar1 MohammadNassar1 requested a review from elintul July 9, 2024 12:37
@codecov-commenter
Copy link

codecov-commenter commented Jul 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.54%. Comparing base (6e74e3f) to head (a32a804).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #416      +/-   ##
==========================================
+ Coverage   83.37%   83.54%   +0.17%     
==========================================
  Files          37       37              
  Lines        1720     1720              
  Branches     1720     1720              
==========================================
+ Hits         1434     1437       +3     
+ Misses        210      206       -4     
- Partials       76       77       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@elintul elintul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @MohammadNassar1)


crates/mempool/src/transaction_queue.rs line 53 at r1 (raw file):

}

/// `TransactionQueue` is used to order transactions by priority.

Refrain from using code object names in doc., as it might become outdated.

Suggestion:

Encapsulates a transaction reference to assess its order (or: priority).

@MohammadNassar1 MohammadNassar1 force-pushed the mohammad/queued-transaction/add-docstring branch from 0d108d6 to a32a804 Compare July 9, 2024 14:03
Copy link
Contributor Author

@MohammadNassar1 MohammadNassar1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 1 files reviewed, all discussions resolved (waiting on @elintul)


crates/mempool/src/transaction_queue.rs line 53 at r1 (raw file):

Previously, elintul (Elin) wrote…

Refrain from using code object names in doc., as it might become outdated.

Done

Copy link
Collaborator

@elintul elintul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @MohammadNassar1)

@MohammadNassar1 MohammadNassar1 merged commit 106a27c into main Jul 10, 2024
8 checks passed
@MohammadNassar1 MohammadNassar1 deleted the mohammad/queued-transaction/add-docstring branch July 10, 2024 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants