Skip to content

Chore: Put the three doc strings about each op together #5708

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.

Sign up for GitHub

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

Merged
jannotti merged 2 commits into from
Aug 25, 2023
Merged

Chore: Put the three doc strings about each op together #5708

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99c7327
Put the three doc strings about each op together
jannotti Aug 24, 2023
682bbb2
Remove unused code path
jannotti Aug 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions data/transactions/logic/assembler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1727,12 +1727,13 @@ func addPseudoDocTags() {
continue
}
msg := fmt.Sprintf("`%s` can be called using `%s` with %s.", spec.Name, name, joinIntsOnOr("immediate", i))
desc, ok := opDocByName[spec.Name]
if ok {
opDocByName[spec.Name] = desc + "<br />" + msg
desc := opDescByName[spec.Name]
Comment thread
jannotti marked this conversation as resolved.
if desc.Short == "" {
desc.Short = msg
} else {
opDocByName[spec.Name] = msg
desc.Short = desc.Short + "<br />" + msg
}
opDescByName[spec.Name] = desc
}
}
}
Expand Down
18 changes: 9 additions & 9 deletions data/transactions/logic/assembler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2978,22 +2978,22 @@ func TestGetSpec(t *testing.T) {
require.Equal(t, "unknown opcode: nonsense", ops.Errors[1].Err.Error())
}

func TestAddPseudoDocTags(t *testing.T) { //nolint:paralleltest // Not parallel because it modifies pseudoOps and opDocByName which are global maps
func TestAddPseudoDocTags(t *testing.T) { //nolint:paralleltest // Not parallel because it modifies pseudoOps and opDescByName which are global maps
partitiontest.PartitionTest(t)
defer func() {
delete(pseudoOps, "tests")
delete(opDocByName, "multiple")
delete(opDocByName, "single")
delete(opDocByName, "none")
delete(opDocByName, "any")
delete(opDescByName, "multiple")
delete(opDescByName, "single")
delete(opDescByName, "none")
delete(opDescByName, "any")
}()

pseudoOps["tests"] = map[int]OpSpec{2: {Name: "multiple"}, 1: {Name: "single"}, 0: {Name: "none"}, anyImmediates: {Name: "any"}}
addPseudoDocTags()
require.Equal(t, "`multiple` can be called using `tests` with 2 immediates.", opDocByName["multiple"])
require.Equal(t, "`single` can be called using `tests` with 1 immediate.", opDocByName["single"])
require.Equal(t, "`none` can be called using `tests` with no immediates.", opDocByName["none"])
require.Equal(t, "", opDocByName["any"])
require.Equal(t, "`multiple` can be called using `tests` with 2 immediates.", opDescByName["multiple"].Short)
require.Equal(t, "`single` can be called using `tests` with 1 immediate.", opDescByName["single"].Short)
require.Equal(t, "`none` can be called using `tests` with no immediates.", opDescByName["none"].Short)
require.Equal(t, "", opDescByName["any"].Short)
}
func TestReplacePseudo(t *testing.T) {
partitiontest.PartitionTest(t)
Expand Down
Loading