feat(docs): compilation report #1309
Open
+144
−25
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
anton-trunov
requested changes
Jan 14, 2025
Comment on lines
+59
to
+69
| [TL-B schema][tlb] of each [Message][message] contains its opcode, which is handy for looking up the auto-generated opcodes as well as confirming the [manually provided ones](/book/structs-and-messages#message-opcodes). For example: | ||
|
|
||
| ```md | ||
| ### Deploy | ||
| TL-B: `deploy#946a98b6 queryId:uint64 = Deploy` | ||
| Signature: `Deploy{queryId:uint64}` | ||
|
|
||
| ### Seven | ||
| TL-B: `seven#00000007 = Seven` | ||
| Signature: `Seven{}` | ||
| ``` |
There was a problem hiding this comment.
Let's
- make it a subsection with its own link
- link the subsection from the messages page
- be more explicit, i.e. provide the corresponding Tact message declarations to their respective TL-B schemes
- explicitly say
0x946a98b6and0x00000007are the opcodes - mention that the opcodes are in hex as it is important for something like
foobar#94609816
|
|
||
| There, the `lshift(){:tact}` getter has a single argument `x`, whereas the `gas(){:tact}` getter has no arguments. | ||
|
|
||
| #### Exit codes {#exit-codes} |
There was a problem hiding this comment.
we should link this subsection from the exit codes page
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.
Also adjusted the generated report itself, just so it's a valid and readable markdown.
Issue
Closes #1094.
Towards #1136 (created the page).
Checklist