diff --git a/docs/source/articles/creatingagameengineplugin.rst b/docs/source/articles/creatingagameengineplugin.rst index 1d371aeb..c37ad079 100644 --- a/docs/source/articles/creatingagameengineplugin.rst +++ b/docs/source/articles/creatingagameengineplugin.rst @@ -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 diff --git a/docs/source/tutorials/prettyprinter.rst b/docs/source/tutorials/prettyprinter.rst index 310e852a..578b4ed5 100644 --- a/docs/source/tutorials/prettyprinter.rst +++ b/docs/source/tutorials/prettyprinter.rst @@ -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. diff --git a/sc2reader/engine/engine.py b/sc2reader/engine/engine.py index 479872df..15c0af66 100644 --- a/sc2reader/engine/engine.py +++ b/sc2reader/engine/engine.py @@ -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