Documented RatifyState
#4759
Open
Documented RatifyState
#4759
+9
−0
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
Soupstraw
force-pushed
the
jj/ratify-state-docs
branch
from
4a38a96
to
29d8427
Compare
lehins
reviewed
Nov 18, 2024
eras/conway/impl/src/Cardano/Ledger/Conway/Governance/Internal.hs
Outdated
Show resolved
Hide resolved
Soupstraw
force-pushed
the
jj/ratify-state-docs
branch
from
122230c
to
1e926d2
Compare
Soupstraw
force-pushed
the
jj/ratify-state-docs
branch
from
1e926d2
to
3be4f8c
Compare
Co-authored-by: Alexey Kuleshevich <[email protected]>
Soupstraw
force-pushed
the
jj/ratify-state-docs
branch
from
3be4f8c
to
8b223f0
Compare
teodanciu
reviewed
Nov 19, 2024
| , rsDelayed :: !Bool | ||
| -- ^ True if all the governance actions will get delayed by one epoch at the |
There was a problem hiding this comment.
This is such a small detail, but i found myself confused about it, so I will write a comment and feel free to ignore it!
I believe the following is true: if one of the actions is a delaying one, then all of them will get delayed and this flag is set to True - is this correct?
If it, then I think it would be clearer to say "True when all the governance actions will get get delayed", instead of "if", because with the "if" I read it as: all of them have to be delaying actions in order for the flag to be set to true.
I'm sure it's subjective - I'm more wanting to make sure I understand how it's actually working!
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.
Description
This PR adds some Haddock comments to
RatifyState.resolves #4641
Checklist
CHANGELOG.mdfor the affected packages.New section is never added with the code changes. (See RELEASING.md)
.cabalandCHANGELOG.mdfiles according to theversioning process.
.cabalfiles for all affected packages are updated.If you change the bounds in a cabal file, that package itself must have a version increase. (See RELEASING.md)
fourmolu(usescripts/fourmolize.sh)scripts/cabal-format.sh)hie.yamlhas been updated (usescripts/gen-hie.sh)