[go: up one dir, main page]

Doc/Michelson: redirect operations on bytes to interactive reference.

Context

Answers this part of #4077:

  • delete the parts about instructions from the static reference:
    • Operations on bytes

The documentation about all the operations on bytes in the interactive reference contains that found in the static reference.

Note that:

  • for SLICE, the condition if offset is in bounds in the static reference does not appear in the interactive reference. Indeed, since offset and len are naturals, if offset + len < length byt, then offset < length byt and is thus within bounds (because it's also positive);
  • For NAT, the part stating that the bytes are allowed to have leading zeros in the static reference does not appear in the interactive reference. This is the natural, intuitive interpretation that goes without saying, I think;
  • likewise for INT, the part stating that the bytes are allowed to have leading zeros for non-negative numbers and leading ones for negative numbers in the static reference does not appear in the interactive reference either for the same reason;
  • a few fixes are operated on the interactive reference's side in michelson-reference!117 (merged).

The inclusion was checked manually by comparing the static and interactive documentations for each type and comparison instruction of the static reference.

Manually testing the MR

make -C docs -j

And then open docs/_build/alpha/michelson.html in a web browser.

Or open the exposed artifacts Documentation - excluding old protocols below, and navigate to docs/_build/alpha/michelson.html.

Checklist

  • Select suitable reviewers using the Reviewers field below.
  • Select as Assignee the next person who should take action on that MR
Edited by Nicolas Ayache

Merge request reports

Loading