Skip to content

Commit

Permalink
Remove erroneous "Notes" from SUB and SUBI instructions (#613)
Browse files Browse the repository at this point in the history
### Description

This PR fixes the documentation of the `SUB` and `SUBI` instructions and
makes it follow the same pattern as the `ADD` and `ADDI` instructions.

The documentation was wrongly using the term "overflow" in the "Notes"
of those two instructions, instead of "underflow" (as used in the longer
explanation below the instruction).

The PR simply removes the erroneous description from the "Notes" and
leaves them empty, as in `ADD` and `ADDI`.

### Before requesting review
- [x] I have reviewed the code myself
  • Loading branch information
ironcev authored Oct 23, 2024
1 parent 6d91f86 commit f9e6b9e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/fuel-vm/instruction-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -669,7 +669,7 @@ Panic if:
| Operation | ```$rA = $rB - $rC;``` |
| Syntax | `sub $rA, $rB, $rC` |
| Encoding | `0x00 rA rB rC -` |
| Notes | `$of` is assigned the overflow of the operation. |
| Notes | |

Panic if:

Expand All @@ -687,7 +687,7 @@ Panic if:
| Operation | ```$rA = $rB - imm;``` |
| Syntax | `subi $rA, $rB, imm` |
| Encoding | `0x00 rA rB i i` |
| Notes | `$of` is assigned the overflow of the operation. |
| Notes | |

Panic if:

Expand Down

0 comments on commit f9e6b9e

Please sign in to comment.