Skip to content

docs: fix a few simple typos #146

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 5, 2021
Merged

docs: fix a few simple typos #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44f4226
docs: fix a few simple typos
timgates42 Jun 30, 2021
a94d20e
Merge branch 'upstream' into bugfix_typos
timgates42 Jul 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/articles/creatingagameengineplugin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Plugins may also handle special ``InitGame`` and ``EndGame`` events. These handl
replay state necessary.

* handleEndGame - is called after all events have been processed and
can be used to perform post processing on aggrated data or clean up
can be used to perform post processing on aggregated data or clean up
intermediate data caches.

Message Passing
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/prettyprinter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ So lets put it all together into the final script, ``prettyPrinter.py``:
Making Improvements
---------------------------

So our script works fine for single files, but what if you want to handle multiple files or directories? sc2reader provides two functions for loading replays: :meth:`~sc2reader.factories.SC2Factory.load_replay` and :meth:`~sc2reader.factories.SC2Factory.load_replays` which return a single replay and a list respectively. :meth:`~sc2reader.factories.SC2Factory.load_replay` was used above for convenience but :meth:`~sc2reader.factories.SC2Factory.load_replays` is much more versitile. Here's the difference:
So our script works fine for single files, but what if you want to handle multiple files or directories? sc2reader provides two functions for loading replays: :meth:`~sc2reader.factories.SC2Factory.load_replay` and :meth:`~sc2reader.factories.SC2Factory.load_replays` which return a single replay and a list respectively. :meth:`~sc2reader.factories.SC2Factory.load_replay` was used above for convenience but :meth:`~sc2reader.factories.SC2Factory.load_replays` is much more versatile. Here's the difference:

* :meth:`~sc2reader.factories.SC2Factory.load_replay`: accepts a file path or an opened file object.
* :meth:`~sc2reader.factories.SC2Factory.load_replays`: accepts a collection of opened file objects or file paths. Can also accept a single path to a directory; files will be pulled from the directory using :func:`~sc2reader.utils.get_files` and the given options.
Expand Down
2 changes: 1 addition & 1 deletion sc2reader/engine/engine.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def handleEventName(self, event, replay)
replay state necessary.
* handleEndGame - is called after all events have been processed and
can be used to perform post processing on aggrated data or clean up
can be used to perform post processing on aggregated data or clean up
intermediate data caches.
Event handlers can choose to ``yield`` additional events which will be injected
Expand Down