Skip to content

Commit

Permalink
docs(gadgets.ts): improve readability of shift gates
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinMinkov committed Nov 1, 2023
1 parent f978ede commit 953439b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/lib/gadgets/gadgets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ const Gadgets = {
* **Important:** The gadgets assumes that its input is at most 64 bits in size.
*
* If the input exceeds 64 bits, the gadget is invalid and does not prove correct execution of the rotation.
* Therefore, to safely use `rightShift()`, you need to make sure that the values passed in are range checked to 64 bits.
* For example, this can be done with {@link Gadgets.rangeCheck64}.
* To safely use `rightShift()`, you need to make sure that the value passed in is range-checked to 64 bits;
* for example, using {@link Gadgets.rangeCheck64}.
*
* @param field {@link Field} element to shift.
* @param bits Amount of bits to shift the {@link Field} element to the right. The amount should be between 0 and 64 (or else the shift will fail).
Expand Down

0 comments on commit 953439b

Please sign in to comment.