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

Proposing a PR to fix a few small typos #145

Closed
timgates42 opened this issue Jun 30, 2021 · 8 comments · Fixed by #146
Closed

Proposing a PR to fix a few small typos #145

timgates42 opened this issue Jun 30, 2021 · 8 comments · Fixed by #146

Comments

@timgates42
Copy link
Contributor

Issue Type

[x] Bug (Typo)

Steps to Replicate and Expected Behaviour

  • Examine docs/source/articles/creatingagameengineplugin.rst, sc2reader/engine/engine.py and observe aggrated, however expect to see aggregated.
  • Examine sc2reader/objects.py and observe acount, however expect to see account.
  • Examine docs/source/tutorials/prettyprinter.rst and observe versitile, however expect to see versatile.
  • Examine docs/source/articles/whatsinareplay.rst and observe unncessary, however expect to see unnecessary.
  • Examine sc2reader/events/game.py and observe targetting, however expect to see targeting.
  • Examine examples/sc2autosave.py and observe substition, however expect to see substitution.
  • Examine sc2reader/resources.py and observe requirments, however expect to see requirements.

Notes

Semi-automated issue generated by
/~https://github.com/timgates42/meticulous/blob/master/docs/NOTE.md

To avoid wasting CI processing resources a branch with the fix has been
prepared but a pull request has not yet been created. A pull request fixing
the issue can be prepared from the link below, feel free to create it or
request @timgates42 create the PR. Alternatively if the fix is undesired please
close the issue with a small comment about the reasoning.

/~https://github.com/timgates42/sc2reader/pull/new/bugfix_typos

Thanks.

@cclauss
Copy link
Collaborator

cclauss commented Jun 30, 2021

How are these typos being missed by codespell running in our automated tests?
/~https://github.com/ggtracker/sc2reader/blob/upstream/.circleci/config.yml#L20

@StoicLoofah
Copy link
Collaborator

@timgates42 Would be great if you could open a PR for it!

@cclauss Great question about codespell. I feel like it has corrected other typos in the past, so it's working to some degree

@timgates42
Copy link
Contributor Author

Thanks @StoicLoofah raised #146

StoicLoofah pushed a commit that referenced this issue Jul 5, 2021
There are small typos in:
- docs/source/articles/creatingagameengineplugin.rst
- docs/source/articles/whatsinareplay.rst
- docs/source/tutorials/prettyprinter.rst
- examples/sc2autosave.py
- sc2reader/engine/engine.py
- sc2reader/events/game.py
- sc2reader/objects.py
- sc2reader/resources.py

Fixes:
- Should read `aggregated` rather than `aggrated`.
- Should read `account` rather than `acount`.
- Should read `versatile` rather than `versitile`.
- Should read `unnecessary` rather than `unncessary`.
- Should read `targeting` rather than `targetting`.
- Should read `substitution` rather than `substition`.
- Should read `requirements` rather than `requirments`.

Closes #145
@cclauss
Copy link
Collaborator

cclauss commented Jul 6, 2021

@timgates42 You might consider contributing some of these off-by-just-one-letter fixes to codespell. Especially the account one might be done in other repos.

@timgates42
Copy link
Contributor Author

Yeah that is a great idea @cclauss - Thanks!

@timgates42
Copy link
Contributor Author

Interestingly @cclauss acount was added back in 2018 - codespell-project/codespell@3f94316

@timgates42
Copy link
Contributor Author

In fact only 2 from this list were missing in the latest version - codespell-project/codespell#2019

@cclauss
Copy link
Collaborator

cclauss commented Jul 18, 2021

“Small moves.” -- Contact

Thanks for doing this.

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 a pull request may close this issue.

3 participants