Skip to content

docs: fix formula notation and heading hierarchy in indexed merkle tree documentation#11408

Closed
savvar9991 wants to merge 2 commits into
AztecProtocol:masterfrom
savvar9991:patch-1
Closed

docs: fix formula notation and heading hierarchy in indexed merkle tree documentation#11408
savvar9991 wants to merge 2 commits into
AztecProtocol:masterfrom
savvar9991:patch-1

Conversation

@savvar9991

Copy link
Copy Markdown

1. Replacing v with new_nullifier:

-low_nullifier_{\textsf{next_value}} > v
+low_nullifier_{\textsf{next_value}} > new_nullifier

This correction is important because:
Eliminates confusion with variable v which isn't used anywhere else

2.Replacing \ | with ||:

-new_nullifier > low_nullifier_{\textsf{value}} : && : ( new_nullifier < low_nullifier_{\textsf{next_value}} : \ | : low_nullifier_{\textsf{next_value}} == 0 )
+new_nullifier > low_nullifier_{\textsf{value}} : && : ( new_nullifier < low_nullifier_{\textsf{next_value}} : || : low_nullifier_{\textsf{next_value}} == 0 )

\ | is an escape sequence for a vertical bar in LaTeX/Markdown
|| is the correct logical OR operator in mathematical formulas
Incorrect operator could lead to misunderstanding of the algorithm logic
Ensures proper rendering of the formula in math mode

3. Changing heading level:

-#### Performance gains from subtree insertion
+### Performance gains from subtree insertion

Makes the heading hierarchy more logical
"Performance gains" is a subsection of "Batch insertions", so it should be h3 level

@savvar9991

Copy link
Copy Markdown
Author

@TomAFrench Sorry for pinging, but could you please take a look at this PR when you have a moment?

@TomAFrench TomAFrench added the redo-typo-pr Automated. label Jan 22, 2025
@TomAFrench TomAFrench added redo-typo-pr Automated. and removed redo-typo-pr Automated. labels Jan 22, 2025
@AztecBot AztecBot closed this Jan 22, 2025
@savvar9991 savvar9991 deleted the patch-1 branch January 23, 2025 10:10
TomAFrench pushed a commit that referenced this pull request Jan 23, 2025
Thanks savvar9991 for
#11408. Our policy
is to redo typo changes to dissuade metric farming. This is an automated
script.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

redo-typo-pr Automated.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants