Deprecate some patterns, remove their internal use#728
Merged
carbolymer merged 5 commits intomasterfrom Jan 20, 2025
Merged
Conversation
2 tasks
a3e7827 to
74c7f2e
Compare
carbolymer
reviewed
Jan 16, 2025
Contributor
carbolymer
left a comment
There was a problem hiding this comment.
I don't know about this change - I don't know how popular are patterns across cardano-api consumers. Those patterns are convenient, but somewhat magical, like TxBody, doing suddenly a whole conversion.
@Jimbo4350 thoughts?
Comment on lines
-55
to
-56
| , AsByronTx | ||
| , AsShelleyTx |
Jimbo4350
approved these changes
Jan 17, 2025
Contributor
Jimbo4350
left a comment
There was a problem hiding this comment.
LGTM however I would not delete the patterns off the bat. Deprecate them first and after 2 major releases we can remove them.
74c7f2e to
0e25624
Compare
0e25624 to
7f8d417
Compare
carbolymer
approved these changes
Jan 20, 2025
smelc
added a commit
to IntersectMBO/cardano-cli
that referenced
this pull request
Jan 23, 2025
CarlosLopezDeLara
pushed a commit
to IntersectMBO/cardano-cli
that referenced
this pull request
Jan 28, 2025
CarlosLopezDeLara
pushed a commit
to IntersectMBO/cardano-cli
that referenced
this pull request
Jan 29, 2025
CarlosLopezDeLara
pushed a commit
to IntersectMBO/cardano-cli
that referenced
this pull request
Jan 29, 2025
smelc
added a commit
to IntersectMBO/cardano-cli
that referenced
this pull request
Jan 29, 2025
newhoggy
pushed a commit
to IntersectMBO/cardano-cli
that referenced
this pull request
Mar 24, 2025
3 tasks
This file contains hidden or 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
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.
Changelog
Context
Our codebase is hard to enter. It's big, it redefines types with the same names from the ledger, it has a complex witness system, it has historical quirks. This PR aims at reducing one of the things you need to understand to contribute to this codebase: patterns. The patterns that are deprecated by this PR are easily replaced by a few functions calls there and there. This shows on the count of lines changed: it's more deletion (51) than additions (22).
In additions, this barely impacts the CLI, as the corresponding CLI PR shows.
For the record, this PR is a spin-off of this work: #724
Follow-up
If this one obtains support, I can go further and deprecate more patterns. Up to reviewers to tell me which direction to go. [edit] Approval obtained, see: #728 (review)
I will also create an issue to follow-up on definitely removing the patterns that are deprecated by this PR.
How to trust this PR
Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.
Checklist