Skip to content

Pedantic comment and language fixes.

Cody requested to merge language-fixes into master

Originally made as !143 (closed) from a fork -- moved for easier pipeline checks. The original description is copied below.

My main focus was on making comments as uniformly and correctly formatted as possible. My guidelines:

  • if the comment was meant as a sentence, I added punctuation accordingly
  • if it was just meant as a simple label, ensure no end-of-sentence punctuation was used
  • if it was meant as a doc-string or TODO but not formatted as such, it was fixed
  • if I saw any misspellings, vocabulary mistakes, or grammatical errors, I fixed them

This ended up extending to some variable names as well, which ended up extending to fixing variables name cases (CamelCase, snake_case, etc.) to match what was appropriate.

I did not try to alter any functionality of the code, even in the case where code was incorrect (see build note below), so none of the code should be different in that regard. I read and double-checked everything thoroughly (within reason), but I realize I may have missed things.

Note: cargo build succeeds despite an error in figurequad.rs which I did not try to fix; I only made a change in the whitespace behind one brace so as to make the error more visibly obvious to whoever might later edit the code.

(P.S. Please don't hate me for this. 😅)

Merge request reports