-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Typographical Errors Across Documentation #166
Conversation
Thanks for finding all of these! While this is helpful, I think that just typo fixing is often seen as something bots do for engagement. I'm not claiming this is the case, but I'm going to make a suggestion: Do you think you can take this a step further and add to documentation or code on top of this? We'd love if you found some areas that were under explained or some code that was less than adequately documented. Another option would be to add a CI check for common misspellings. I think there's a tool called "Codespell"? If you could help us set that up in a way that would not be too tedious (that is to say, make it so it does not find typo errors in code itself in ways that are obtuse) then that would also be a really excellent contribution. Thank you for going through this and finding these mistakes! |
Hi! @Autoparallel done |
Nice work @cypherpepe! I appreciate you :) Seems like we have some broken items in the CI pipeline now. See: https://github.com/pluto/ronkathon/actions/runs/12394958398/job/34604002218?pr=166 Want to help clean these up? |
Done @Autoparallel check it |
Running CI again! |
Thank you for your contribution @cypherpepe Please come back again!!! We love to see you here :) |
This PR fixes multiple typographical errors and improves consistency across the documentation files.
Changes:
Corrected spelling mistakes:
anvd
→and
remanining
→remaining
untill
→until
refrence
→reference
subsitution
→substitution
evauluate
→evaluate
Affected files include:
README.md
src/algebra/field/README.md
src/codes/README.md
src/encryption/asymmetric/rsa/README.md
src/encryption/symmetric/des/README.md
src/hashes/poseidon/README.md
src/kzg/README.md