Skip to content
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

Merged
merged 22 commits into from
Dec 18, 2024

Conversation

cypherpepe
Copy link
Contributor

This PR fixes multiple typographical errors and improves consistency across the documentation files.

Changes:

  • Corrected spelling mistakes:

    • anvdand
    • remaniningremaining
    • untilluntil
    • refrencereference
    • subsitutionsubstitution
    • evauluateevaluate
    • and other minor typos.
  • 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

@Autoparallel
Copy link
Contributor

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!

@cypherpepe
Copy link
Contributor Author

Hi! @Autoparallel done

@Autoparallel
Copy link
Contributor

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?

@cypherpepe
Copy link
Contributor Author

Done @Autoparallel check it

@Autoparallel
Copy link
Contributor

Running CI again!

@Autoparallel
Copy link
Contributor

Thank you for your contribution @cypherpepe

Please come back again!!! We love to see you here :)

@Autoparallel Autoparallel merged commit 04093e2 into pluto:main Dec 18, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants