-
Notifications
You must be signed in to change notification settings - Fork 15
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
cardano-ledger.pdf clean up #663
Comments
My opinion on some of these things:
|
We should make a concerted effort to respond to community feedback and it seems the community finds the documentation cryptic. In my view, the obvious solution is to hide less and explain more about how things are defined in Agda. |
4 tasks
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Showdata
keyword consistently. (It appears in some figures e.g., Fig 8, 9, 12, but not others e.g., Fig 7, 20, 24).record
keyword consistently. (It appears in most figures, but hidden in some, e.g.,record PKKScheme
in Fig 3,record TransactionStructure
in Fig 17.)UTxO states
andUTxO transitions
in Fig 20.data
keyword, type signature, and definition for all transition rules so they are much easier to make sense of.data
andwhere
keyword in Fig 1 (_⊢_⇀⟦_⟧*_ : C → S → List Sig → S → Type
)._⊢_⇀⦇_,GOV'⦈_
is hidden, which makes the line,_⊢_⇀⦇_,GOV⦈_ = ReflexiveTransitiveClosureᵢ {sts = _⊢_⇀⦇_,GOV'⦈_}
, at bottom of figure incomprehensible.)_⊢_⇀⦇_,RATIFY⦈_
defined in terms of_⊢_⇀⦇_,RATIFY'⦈_
but the latter is hidden.LEDGER
rule (Figs 41, 42) into one figure.CHAIN
rule (Figs 58, 59).ENACT
rule to the figure containing its definition.data
keyword and type signature forEPOCH
rule (Fig 55).isUnregisteredDRep
in Fig 40 is off; same for def ofacceptConds
in Fig 51.DELEG-delegate
is broken up into multiple lines, making it a bit confusing to readThe text was updated successfully, but these errors were encountered: