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

Rename the term Ticket Quality to Ticket Rank for better readability #633

Merged
merged 1 commit into from
Sep 5, 2024

Conversation

masih
Copy link
Member

@masih masih commented Sep 5, 2024

The Converge ticket selection mechanism previously used the term "quality" to determine which ticket is better where the lower the quality value the better the ticket.

Additionally, the term "quality" is already used in GPBFT for QUALITY phase, which is a totally different thing.

To avoid terminology confusion, and for a more intuitive notion in the context of ticket selection use the term "rank" instead, where instead one would say: whichever ticket ranks first is better, i.e. the smaller the value of rank the better the ticket.

While at it, update the docs on the compute function.

The Converge ticket selection mechanism previously used the term
"quality" to determine which ticket is better where the lower the
quality value the better the ticket.

Additionally, the term "quality" is already used in GPBFT for `QUALITY`
phase, which is a totally different thing.

To avoid terminology confusion, and for a more intuitive notion in the
context of ticket selection use the term "rank" instead, where instead
one would say: whichever ticket ranks first is better, i.e. the smaller
the value of rank the better the ticket.

While at it, update the docs on the compute function.
@masih masih requested review from Kubuxu and Stebalien September 5, 2024 16:36
Copy link

codecov bot commented Sep 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.44%. Comparing base (ff0b6f5) to head (795542e).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #633      +/-   ##
==========================================
- Coverage   79.83%   79.44%   -0.39%     
==========================================
  Files          52       52              
  Lines        4676     4676              
==========================================
- Hits         3733     3715      -18     
- Misses        592      601       +9     
- Partials      351      360       +9     
Files with missing lines Coverage Δ
gpbft/gpbft.go 87.30% <100.00%> (ø)
gpbft/ticket_rank.go 84.61% <100.00%> (ø)

... and 4 files with indirect coverage changes

@masih masih enabled auto-merge September 5, 2024 17:07
@masih masih added this pull request to the merge queue Sep 5, 2024
@Stebalien
Copy link
Member

(I don't think this one will be controversial...)

Merged via the queue into main with commit a1788ca Sep 5, 2024
13 checks passed
@masih masih deleted the masih/ticket-rank-terminology branch September 5, 2024 18:12
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.

2 participants