search

privacy-scaling-explorations / sonobe

Experimental folding schemes library
https://privacy-scaling-explorations.github.io/sonobe-docs/
MIT License
205 stars 54 forks source link

Docs fix spelling issues #152

Closed nnsW3 closed 1 week ago

nnsW3 commented 3 months ago

Hello I found several spelling issues. Hope it helps Br, Elias.

arnaucube commented 3 months ago

Hi @nnsW3 , thanks for the typos fixes. In this repo some months ago we added into the CI pipeline the tool typos to prevent many typos from happening, but it will only detect miss-spellings of words, not wrong usages or errors on sentences as the ones that you're fixing in this PR.

From what I see in your github profile, eg. https://github.com/Cyfrin/foundry-full-course-cu/pull/2301, https://github.com/starkware-libs/blockifier/pull/2108, https://github.com/near/nearcore/pull/11906, https://github.com/matter-labs/zksync-era/pull/2611 , etc (more than 100 PRs to different projects fixing typos), seems like you're using some more advanced tool to detect these kind of typos that are not misspelling of words but more like sentence errors or wrong usage of words.

Is it some tool that we could integrate in the CI pipeline of this repo, so that future similar typos can be automatically detected avoiding more human friction? Thanks in advance.

CPerezz commented 1 month ago

Seems he's not going to get back to us. Likely a script that is farming airdrops.

CPerezz commented 1 month ago

Can we close this @arnaucube? SO we have less PRs to navigate through

nnsW3 commented 1 month ago

Hi @nnsW3 , thanks for the typos fixes. In this repo some months ago we added into the CI pipeline the tool typos to prevent many typos from happening, but it will only detect miss-spellings of words, not wrong usages or errors on sentences as the ones that you're fixing in this PR.

From what I see in your github profile, eg. Cyfrin/foundry-full-course-cu#2301, starkware-libs/blockifier#2108, near/nearcore#11906, matter-labs/zksync-era#2611 , etc (more than 100 PRs to different projects fixing typos), seems like you're using some more advanced tool to detect these kind of typos that are not misspelling of words but more like sentence errors or wrong usage of words.

Is it some tool that we could integrate in the CI pipeline of this repo, so that future similar typos can be automatically detected avoiding more human friction? Thanks in advance.

no, I have done it manually and spent a lot of time finding errors I just try to contribute to the space with my knowledge. I'm just a junior developer yet... so more meaningful contributions are out of my hand for now...

arnaucube commented 1 month ago

But, are you reading line by line all those repositories where you open PRs fixing issues in order to find those kind of typos? We're talking about more than 100 PRs to 100 different repos, each of them with thousands lines of code. I would use some tool instead.

I was asking because maybe we can integrate that tool in the CI so that in the future similar typos are detected automatically.