More documentation changes.

Author: GraylinKim

docs/source/articles/conceptsinsc2reader.rst

@@ -9,10 +9,10 @@ Factories
 
 All resources are loaded through a factory. There are four kinds:
 
-* SC2Factory - Basic factory. Loads resources.
-* DictCachedSC2Factory - Caches remote resources in memory. When loading remote resources, the dict cache is checked first.
-* FileCachedSC2Factory - Caches remote resources on the file system. When loading remote resources, the file system is checked first.
-* DoubleCachedSC2Factory - Caches remote resource in memory and on the file system.
+* :class:`~sc2reader.factories.SC2Factory` - Basic factory. Loads resources.
+* :class:`~sc2reader.factories.DictCachedSC2Factory` - Caches remote resources in memory. When loading remote resources, the dict cache is checked first.
+* :class:`~sc2reader.factories.FileCachedSC2Factory` - Caches remote resources on the file system. When loading remote resources, the file system is checked first.
+* :class:`~sc2reader.factories.DoubleCachedSC2Factory` - Caches remote resource in memory and on the file system.
 
 A default factory is automatically configured and attached to the ``sc2reader`` module when the library is imported. Calling any factory method on the sc2reader module will use this default factory::
 

docs/source/index.rst

@@ -45,10 +45,10 @@ Scripts:
 * sc2json: Render basic replay information to json for use in other languages.
 * sc2replayer: Play back a replay one event at a time with detailed printouts.
 
-I am actively looking for community members to assist in documenting the replay data and in creating plugins that enhance functionality. Contact me!
+I am actively looking for community members to assist in documenting the replay data and in creating plugins that enhance functionality. `Contact me`_!
 
 .. _source: http://github.com/GraylinKim/sc2reader
-
+.. _Contact me: mailto://[email protected]
 
 Getting Started
 --------------------
@@ -59,7 +59,7 @@ I recommend the following steps when getting started:
 * Read this article on replays: :doc:`articles/whatsinareplay` (5 minutes).
 * Read this article on sc2reader: :doc:`articles/conceptsinsc2reader` (5 minutes).
 
-After that, you can see sc2reader in action by working through a couple of the tutorials below.
+Now that you've been oriented, you can see sc2reader in action by working through a couple of the tutorials below.
 
 .. _installation guide: https://github.com/GraylinKim/sc2reader#installation
 
@@ -72,6 +72,14 @@ The best way to pick sc2reader up and get started is probably by example. With t
 * :doc:`tutorials/prettyprinter` (10-15 minutes)
 
 
+Articles
+----------------
+
+* :doc:`articles/whatsinareplay` (5 minutes).
+* :doc:`articles/conceptsinsc2reader` (5 minutes).
+* :doc:`articles/creatingagameengineplugin` (10 minutes).
+
+
 Reference Pages
 -----------------------
 

sc2reader/engine/engine.py

@@ -51,11 +51,11 @@ def handleTargetAbilityEvent(self, event, replay):
             engine.reigster_plugin(Plugin(5))
             engine.run(replay)
 
-        Calls functions in the following order for a ``TargetUnitEvent``::
+        Calls functions in the following order for a ``TargetAbilityEvent``::
 
-            Plugin1.handleAbilityEvent(replay, event)
-            Plugin2.handleEvent(replay, event)
-            Plugin2.handleTargetAbilityEvent(replay, event)
+            Plugin1.handleAbilityEvent(event, replay)
+            Plugin2.handleEvent(event, replay)
+            Plugin2.handleTargetAbilityEvent(event, replay)
 
 
         Plugin Specification