Chore: Put the three doc strings about each op together#5708
Merged
jannotti merged 2 commits intoalgorand:masterfrom Aug 25, 2023
Merged
Chore: Put the three doc strings about each op together#5708jannotti merged 2 commits intoalgorand:masterfrom
jannotti merged 2 commits intoalgorand:masterfrom
Conversation
jannotti
changed the title
This PR should not affect any run-time behavior, nor any generated specs. It simply puts all of the documentation for an opcode together in one place, so it's slightly easier to add opcodes and find all of the documentation about an opcode in the source. An eventual further change might be to get the documentaion into the OpSpecs themselves, as there is still a little confusion there - immediates are _named_ in the OpSpec, but documented in doc.go.
jannotti
force-pushed
the
specs-doc-cleanup
branch
from
6ee32b6 to
99c7327
Compare
Codecov Report
@@ Coverage Diff @@
## master #5708 +/- ##
==========================================
- Coverage 55.38% 54.69% -0.69%
==========================================
Files 466 466
Lines 65734 65734
==========================================
- Hits 36407 35955 -452
- Misses 26877 27293 +416
- Partials 2450 2486 +36
... and 51 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
ahangsu
previously approved these changes
Aug 24, 2023
Contributor
ahangsu
left a comment
ahangsu
left a comment
There was a problem hiding this comment.
This PR essentially merge following 3 things:
opDocByNameopDocExtrasopcodeImmediateNotes
into one map of OpDesc.
Removed the code path that allows pseudo-ops to execute non-existant opcodes. Changed tests to not test this path, and instead test that the pseudo-op annotation was properly placed on real opcode.
This was referenced Oct 13, 2023
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR should not affect any run-time behavior, nor any generated specs. It simply puts all of the documentation for an opcode together in one place, so it's slightly easier to add opcodes and find all of the documentation about an opcode in the source.
An eventual further change might be to get the documentaion into the OpSpecs themselves, as there is still a little confusion there - immediates are named in the OpSpec, but documented in doc.go.
The "test plan" here is really just that the generated specs are unchanged.