Fix links in Rewards module; migrate Transaction #935
Conversation
This closes issue #934.
carlostome
left a comment
carlostome
left a comment
There was a problem hiding this comment.
LGTM! Left some comments here and there. Some are related to the content of Transaction not the migration itself but I thought we could use the opportunity to improve it.
| + The hash of the serialized form of the transaction that was included | ||
| in the block. |
There was a problem hiding this comment.
Missing what field this is talking about
| --> | ||
|
|
||
|
|
||
| ## Transaction Functions |
There was a problem hiding this comment.
I think it's better if the header of the section of each module where functions related to that module are defined should refer to the name of the module itself; we already do this elsewhere, e.g., "Certification Functions" (or "Certificates Functions"?), "Governance Functions", etc. Making the subsection titles more specific, less generic, seems preferable to me.
| \begin{code} | ||
| ``` | ||
|
|
||
| *Abstract types* |
There was a problem hiding this comment.
Maybe make these headings into subsubsections?
There was a problem hiding this comment.
Hmmm... that might be a good idea. I'm not sure. We've always had these kinds of type labels, since the era of pdfs. Of course, that doesn't mean it's the right way to present them. But I wonder if it's best to keep record types contained in a single subsection, rather than spreading their fields across subsections. 🤔 That might be better for getting a "high level" understanding of the code. Though I suppose splitting a large record up into subsections with explanatory prose would make it easier to explain things at a "low level."
Well, I'll leave it for now and we can discuss whether improvements should be made in a future issue/PR.
| ``` | ||
| --> | ||
|
|
||
| *Derived types* |
There was a problem hiding this comment.
Same as previous comment
| ``` | ||
| --> | ||
|
|
||
| *Transaction types* |
There was a problem hiding this comment.
Same as previous comments
williamdemeo
force-pushed
the
934-broken-links-and-formatting-errors
branch
from
04e1c4c to
351e20a
Compare
plus final cleanup of prose Co-authored-by: Carlos Tomé Cortiñas <[email protected]>
williamdemeo
force-pushed
the
934-broken-links-and-formatting-errors
branch
from
351e20a to
021604b
Compare
2 participants
Description
This closes issue #934.
Checklist
CHANGELOG.md