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

Clarifying Documentation Through Corrections in Code Comments #954

Closed
wants to merge 9 commits into from

Conversation

joaolago1113
Copy link

I've made a few small fixes in the code. These changes will make things clearer and more professional.
Here's what I've done:

  1. Commit 1510c48: Fixed a spelling mistake - 'occurences' to 'occurrences'.
  2. Commit 2dd6575: Changed 'proogs' to 'proofs'.
  3. Commit 6467072: Corrected 'it's purpose' to 'its purpose'.
  4. Commit 62ee7f0: Fixed 'profiile' to 'profile'.
  5. Commit 66596e9: Updated 'encoutering' to 'encountering'.
  6. Commit 8ce301e: Changed 'overhide' to 'override' and 'accross' to 'across'.
  7. Commit 7aa874f: Tweaked an error message to make it clearer.
  8. Commit b107688: Fixed a confusing part where 'doesn't not' should be 'does not'.
  9. Commit 62d1f4c: Corrected 'methdods' to 'methods'.

The fix in commit b107688 is important because it was misleading before with the double negative "doesn't not", please check that the correct way is "does not".

@CLAassistant
Copy link

CLAassistant commented Dec 8, 2023

CLA assistant check
All committers have signed the CLA.

@ivokub ivokub added P3: Low Issue priority: low typo Fixes typos in comments or documentation labels Dec 12, 2023
@gbotrel
Copy link
Collaborator

gbotrel commented Jan 3, 2024

Thanks for the PR. However, we decided to close PRs with formatting / typo fixes only at the moment (as per the CONTRIBUTING.md).

@gbotrel gbotrel closed this Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3: Low Issue priority: low typo Fixes typos in comments or documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants