Skip to content

Commit

Permalink
doc: improve JSDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
renzobanegass committed Aug 9, 2024
1 parent a7aca56 commit 2794d0b
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/hints/math/testLessThanOrEqualAddress.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,11 @@ export type TestLessThanOrEqualAddress = z.infer<
/**
* TestLessThanOrEqualAddress hint
*
* Compares the values at the relocatable values `lhs` and `rhs` and stores
* the result in `dst`. The result is `1` if the value at `lhs` is
* less than or equal to the value at `rhs`, and `0` otherwise.
* Check whether the Relocatable value at `lhs` is inferior or equal to the value at `rhs`
*
* @param {VirtualMachine} vm - The virtual machine instance.
* @param {ResOperand} lhs - The relocatable value of the left-hand side operand.
* @param {ResOperand} rhs - The relocatable value of the right-hand side operand.
* @param {ResOperand} lhs - The left-hand side operand.
* @param {ResOperand} rhs - The right-hand side operand.
* @param {CellRef} dst - The address where the result of the comparison will be stored.
*/
export const testLessThanOrEqualAddress = (
Expand Down

0 comments on commit 2794d0b

Please sign in to comment.