Skip to content

Commit 2531a07

Browse files
dbanks12dbanks12
committed
Docs: Escape leading asterisks in notes for AVM opcodes
Escaped leading asterisks in 'See [Gas Metering]' and 'Note:' phrases within the AVM opcode documentation. This prevents them from being misinterpreted as markdown bullet points, improving rendering consistency. The changes affect all files in 'yarn-project/simulator/docs/avm/opcodes/'. The italic formatting of the phrases is preserved.
1 parent 3f55981 commit 2531a07

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+93
-93
lines changed

‎yarn-project/simulator/docs/avm/opcodes/add.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Performs addition. Both operands must have the same type tag. For integer types
2222
| DA Base | 0 | - |
2323
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
2424

25-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
25+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
2626

2727
## Operands
2828

@@ -110,4 +110,4 @@ packet-beta
110110

111111
---
112112

113-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
113+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

‎yarn-project/simulator/docs/avm/opcodes/and.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Performs bitwise AND operation. Both operands must have the same integral type t
2323
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
2424
| L2 Dynamic | 3 | - |
2525

26-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
26+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
2727

2828
## Operands
2929

@@ -113,4 +113,4 @@ packet-beta
113113

114114
---
115115

116-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
116+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

‎yarn-project/simulator/docs/avm/opcodes/call.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Calls another contract with the specified calldata and gas allocation. Can modif
2929
| DA Base | 0 | - |
3030
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
3131

32-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
32+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
3333

3434
## Operands
3535

@@ -122,4 +122,4 @@ packet-beta
122122

123123
---
124124

125-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
125+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

‎yarn-project/simulator/docs/avm/opcodes/calldatacopy.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Copies a section of the current call's calldata into memory at the specified off
2323
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
2424
| L2 Dynamic | 3 | `M[copySizeOffset]` |
2525

26-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
26+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
2727

2828
## Operands
2929

@@ -99,4 +99,4 @@ packet-beta
9999

100100
---
101101

102-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
102+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

‎yarn-project/simulator/docs/avm/opcodes/cast.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Changes the type tag of a value. The value itself is preserved if casting to a l
2222
| DA Base | 0 | - |
2323
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
2424

25-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
25+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
2626

2727
## Operands
2828

@@ -106,4 +106,4 @@ packet-beta
106106

107107
---
108108

109-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
109+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

‎yarn-project/simulator/docs/avm/opcodes/debuglog.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Prints a debug log to console as a formatted message, and pushes a structured de
2222
| DA Base | 0 | - |
2323
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
2424

25-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
25+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
2626

2727
## Operands
2828

@@ -96,4 +96,4 @@ packet-beta
9696

9797
---
9898

99-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
99+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

‎yarn-project/simulator/docs/avm/opcodes/div.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Performs integer division (truncating). Both operands must have the same integra
2222
| DA Base | 0 | - |
2323
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
2424

25-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
25+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
2626

2727
## Operands
2828

@@ -113,4 +113,4 @@ packet-beta
113113

114114
---
115115

116-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
116+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

‎yarn-project/simulator/docs/avm/opcodes/ecadd.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Performs elliptic curve point addition on the Grumpkin curve. Each point is repr
2525
| DA Base | 0 | - |
2626
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
2727

28-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
28+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
2929

3030
## Operands
3131

@@ -120,4 +120,4 @@ packet-beta
120120

121121
---
122122

123-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
123+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

‎yarn-project/simulator/docs/avm/opcodes/emitnotehash.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Writes a new note hash to the Note Hash Tree. Note hash must have type tag FIELD
2222
| DA Base | 512 | - |
2323
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
2424

25-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
25+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
2626

2727
## Operands
2828

@@ -87,4 +87,4 @@ packet-beta
8787

8888
---
8989

90-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
90+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

‎yarn-project/simulator/docs/avm/opcodes/emitnullifier.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Writes a new nullifier to the Nullifier Tree. This opcode can only emit nullifie
2222
| DA Base | 512 | - |
2323
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset<br/>3 L2 gas per relative memory offset |
2424

25-
*See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
25+
\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
2626

2727
## Operands
2828

@@ -88,4 +88,4 @@ packet-beta
8888

8989
---
9090

91-
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)
91+
[&larr; Back to Instruction Set: Quick Reference](../avm-isa-quick-reference.md)

0 commit comments

Comments
 (0)