Skip to content

Commit af3628e

Browse files
authored
Merge pull request #146 from timgates42/bugfix_typos
docs: fix a few simple typos
2 parents dffaf57 + a94d20e commit af3628e

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/source/articles/creatingagameengineplugin.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Plugins may also handle special ``InitGame`` and ``EndGame`` events. These handl
5252
replay state necessary.
5353

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

5858
Message Passing

docs/source/tutorials/prettyprinter.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ So lets put it all together into the final script, ``prettyPrinter.py``:
182182
Making Improvements
183183
---------------------------
184184

185-
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:
185+
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:
186186

187187
* :meth:`~sc2reader.factories.SC2Factory.load_replay`: accepts a file path or an opened file object.
188188
* :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.

sc2reader/engine/engine.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def handleEventName(self, event, replay)
6969
replay state necessary.
7070
7171
* handleEndGame - is called after all events have been processed and
72-
can be used to perform post processing on aggrated data or clean up
72+
can be used to perform post processing on aggregated data or clean up
7373
intermediate data caches.
7474
7575
Event handlers can choose to ``yield`` additional events which will be injected

0 commit comments

Comments
 (0)