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

Other PDF cleanup items: Fig 5 (Token algebras) #298

Merged
merged 3 commits into from
Nov 14, 2023

Conversation

williamdemeo
Copy link
Contributor

Description

Address items in issue #289.

  • align the field keywords in the TokenAlgebra record type.
  • say what PolicyID is for.
  • add [h!] to figure environment so the figure does not appear above the section heading ("4 Token algebras").

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • Code is formatted according to CONTRIBUTING.md
  • Self-reviewed the diff

Address an item in issue #289.

- [X] align the `field` keywords in the `TokenAlgebra` record type.
- [X] say what `PolicyID` is for.
@@ -53,5 +54,6 @@ record TokenAlgebra : Set₁ where
sumᵛ : List Value → Value
sumᵛ = foldr _+ᵛ_ (inject 0)
\end{code}
\caption{Token algebras, used for multi-assets}
\end{AgdaAlign}
\caption{Token algebras, used for multi-assets; \AgdaBound{PolicyId} specifies a type (e.g., with natural numbers) used to represent policy identifiers.}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have a pattern for this, see the figure right below (Definitions used in Addresses). Maybe that pattern isn't that great (if you don't like it, make an issue to change it everywhere), but this should still follow it otherwise it's confusing (is PolicyID not an abstract type?).

Copy link
Contributor Author

@williamdemeo williamdemeo Nov 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I'll check out the existing pattern and conform.

PolicyID : Type is a parameter passed into this (the TokenAlgebra) module (so, yeah, I suppose it would be considered an "abstract type").

Also change `\begin{figure*}[h]` to `\begin{figure*}[h!]` in `Address.lagda` so
that the figure appears on the same page as the section header, rather than a
mostly blank page under the header, preceding the figure.
@williamdemeo
Copy link
Contributor Author

@WhatisRT I think this PR is good to go now.

Copy link
Collaborator

@WhatisRT WhatisRT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@WhatisRT WhatisRT merged commit 60f3638 into master Nov 14, 2023
3 checks passed
@WhatisRT WhatisRT deleted the william/289-fig5-policyid-type branch November 14, 2023 11:01
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