risc0 icon indicating copy to clipboard operation
risc0 copied to clipboard

Systematically fix all the typos discovered with the help of JetBrains

Open weikengchen opened this issue 1 year ago • 2 comments

We are going to see more "small" typo PRs in the coming months due to airdrop expectation, though to my belief, RISC Zero never mentions having a token. It is good though to have early participants. Nevertheless, it sometimes becomes a headache when each of the PRs is too small, and it takes resources to do CI and many manual reviews.

A solution to handle this issue is to fix ALL the obvious typos systematically in a single attempt, so that even if in the future people discover new typos, these typos must be hidden deep, and the efforts can be appreciated.

An approach that Alessandro Chiesa taught us in the grad school is to use a spellchecker and manually go through every reported typo. Today we can just use JetBrains. There is a secret tool in Code -> Analyze Code -> Run inspection by name... => "Typo".

JetBrains proposes about 4000 typos---this is pedantic because JetBrains would consider revm, zkvm, etc to be typos. Human inspection is now needed. After a manual walkthrough, this PR contains all the typos that survive the human inspection.

Typos are not avoidable. Compared to other projects, RISC Zero does write a lot of documents in the code.

In addition, just to leave a last sentence: if you are using Mac, my experience in the grad school is that you might be using a keyboard that has been recalled. All the typos appear to be a result of sticky keyboard. https://support.apple.com/keyboard-service-program-for-mac-notebooks And by "a small percentage" in Mac's announcement, it means all. The problem is about the butterfly keyboard design used throughout those years.

weikengchen avatar Jan 11 '24 10:01 weikengchen

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 12, 2024 5:57am

vercel[bot] avatar Jan 11 '24 10:01 vercel[bot]

And just a note that some pending typo PRs are still fairly novel as they found non-spelling issues.

If people are interested, the current repository mentions SHA-256 a few times in the hashing HAL and others, but the hashfn is indeed being parameterized now, and the SHA-256 that the comment said may be actually Poseidon (and by default, Poseidon).

weikengchen avatar Jan 11 '24 10:01 weikengchen

This looks really interesting: https://github.com/privacy-scaling-explorations/folding-schemes/pull/76

flaub avatar Mar 12 '24 05:03 flaub

oh my god we got headlined in PSE.

weikengchen avatar Mar 12 '24 06:03 weikengchen

Superseded by #1683

flaub avatar Apr 18 '24 02:04 flaub