privacy-scaling-explorations / zk-kit

A monorepo of reusable libraries for zero-knowledge technologies.
https://zkkit.pse.dev
MIT License
295 stars 80 forks source link

Update README.md - Fix Spelling and Grammar #352

Closed Madmaxs2 closed 3 days ago

Madmaxs2 commented 4 days ago

Description

This PR fixes spelling errors in the benchmarks documentation to improve clarity and technical accuracy.

Changes Made in benchmarks/README.md:

  1. Changed "leafs" to "leaves" (correct plural form)
  2. Changed "theorical" to "theoretical" (correct spelling)

Before: The Benchmarks suggested in the index.ts are for 8, 128 and 1024 leafs to see how each Merkle tree for different sizes of trees perform because their theorical expected behavior...

After: The Benchmarks suggested in the index.ts are for 8, 128 and 1024 leaves to see how each Merkle tree for different sizes of trees perform because their theoretical expected behavior...

Rationale

  1. "Leaves" is the correct plural form of "leaf" in technical contexts, especially when referring to tree data structures
  2. "Theoretical" is the correct spelling of the word describing concepts based on theory rather than practice

Related Issue(s)

Checklist

These changes improve the technical accuracy and professional appearance of the documentation.

gitpoap-bot[bot] commented 3 days ago

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 ZK-KIT Contributor:

GitPOAP: 2024 ZK-KIT Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.