Human-readable annotations

Contexts may include a human-readable comment. This feature is included to assist in human annotation of ethdebug/format data and is not primarily for compilers to use.

Explore
View source
Playground

Loading ....

YAML
JSON

ethdebug/format/program/context/remark
$schema: "https://json-schema.org/draft/2020-12/schema"
$id: "schema:ethdebug/format/program/context/remark"

title: ethdebug/format/program/context/remark
description: |
  Human-readable information about the instruction. This field is intended
  primarily not for compilers to use directly, but rather for humans
  (directly or indirectly) to use as an annotation field.

type: object
properties:
  remark:
    type: string

required:
  - remark

examples:
  - remark: "jump to end if zero"

ethdebug/format/program/context/remark
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "schema:ethdebug/format/program/context/remark",
  "title": "ethdebug/format/program/context/remark",
  "description": "Human-readable information about the instruction. This field is intended\nprimarily not for compilers to use directly, but rather for humans\n(directly or indirectly) to use as an annotation field.\n",
  "type": "object",
  "properties": {
    "remark": {
      "type": "string"
    }
  },
  "required": [
    "remark"
  ],
  "examples": [
    {
      "remark": "jump to end if zero"
    }
  ]
}