Skip to content

Commit 744ca18

Browse files
authored
Merge pull request #153 from ethdebug/context-descriptions
Add descriptions to `then` schemas in context schema clauses
2 parents a9dbbbb + 9578d54 commit 744ca18

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

schemas/program/context.schema.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,26 +29,40 @@ allOf:
2929
- if:
3030
required: ["code"]
3131
then:
32+
description: |
33+
The context's corresponding source code range.
3234
$ref: "schema:ethdebug/format/program/context/code"
3335
- if:
3436
required: ["variables"]
3537
then:
38+
description: |
39+
Variable definitions, types, allocations known to exist in the context.
3640
$ref: "schema:ethdebug/format/program/context/variables"
3741
- if:
3842
required: ["remark"]
3943
then:
44+
description: |
45+
Human-readable context annotation. Not intended for compiler use.
4046
$ref: "schema:ethdebug/format/program/context/remark"
4147
- if:
4248
required: ["pick"]
4349
then:
50+
description: |
51+
Alternation between several possible contexts.
4452
$ref: "schema:ethdebug/format/program/context/pick"
4553
- if:
4654
required: ["gather"]
4755
then:
56+
description: |
57+
Collection of multiple known, separate contexts.
4858
$ref: "schema:ethdebug/format/program/context/gather"
4959
- if:
5060
required: ["frame"]
5161
then:
62+
description: |
63+
For use by compilers with multiple pipeline outputs (e.g., use of an
64+
intermediary representation) to associate a
65+
context with a particular compiler step.
5266
$ref: "schema:ethdebug/format/program/context/frame"
5367

5468
unevaluatedProperties: false

0 commit comments

Comments
 (0)