-
Notifications
You must be signed in to change notification settings - Fork 20
Rename RwdAddr to RewardAddress #985
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
Conversation
carlostome
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! I left a few comments about dissaligned figures due to the length of RewardAddress (compared to RwdAddr)
| indexOfDCert : DCert → List DCert → Maybe Ix | ||
| indexOfRwdAddr : RwdAddr → Withdrawals → Maybe Ix | ||
| indexOfRewardAddress : RewardAddress → Withdrawals → Maybe Ix | ||
| indexOfTxIn : TxIn → ℙ TxIn → Maybe Ix | ||
| indexOfPolicyId : ScriptHash → ℙ ScriptHash → Maybe Ix |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missaligned
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, and I think this is one of those cases where it even improves readability to align the argument types of the fields, since they're all of the same shape.
| indexOfDCert : DCert → List DCert → Maybe Ix | ||
| indexOfRwdAddr : RewardAddress → Withdrawals → Maybe Ix | ||
| indexOfRewardAddress : RewardAddress → Withdrawals → Maybe Ix | ||
| indexOfTxIn : TxIn → ℙ TxIn → Maybe Ix |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missaligned
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as above (re. aligning argument types as well).
3aae3ba to
97bf12d
Compare
update CHANGELOG to reflect rename
and improve explanation of well-formedness
4267565 to
9682a73
Compare
carlostome
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
Description
Closes issue #984.
Copilot's Description
This pull request refactors the codebase to rename the type
RwdAddrtoRewardAddressthroughout the project. This change improves clarity and consistency in naming, making it easier to understand the purpose of the type as representing a reward address. The update touches many files across the Haskell, Agda, Markdown, and LaTeX code, ensuring the new name is used everywhere relevant.Type and API Renaming
RwdAddrtoRewardAddressacross all Agda modules, type definitions, and usages, including record fields, function parameters, and map types. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20]Function and Variable Updates
RwdAddr(such astoRwdAddr) to useRewardAddress(such astoRewardAddress). [1] [2] [3] [4]Documentation and Macros
RewardAddressinstead ofRwdAddrfor accuracy and consistency. [1] [2]This change is purely a renaming/refactoring and does not affect the underlying logic or behavior of the code. It should make the codebase clearer for future development and maintenance.
Checklist
CHANGELOG.md