summaryrefslogtreecommitdiff
path: root/pokemontools/vba
diff options
context:
space:
mode:
authorBryan Bishop <kanzure@gmail.com>2013-10-12 16:29:03 -0500
committerBryan Bishop <kanzure@gmail.com>2013-10-12 16:29:03 -0500
commit819d16726ec2e4cbe04c6803539b4c13014717b5 (patch)
tree84f9c976ee13ad52b200d6ef81605220d1a4d607 /pokemontools/vba
parent2328b2bd3addc7034e2a7d14dc39e39b7627df82 (diff)
improve some VBA-related docstrings
Diffstat (limited to 'pokemontools/vba')
-rw-r--r--pokemontools/vba/autoplayer.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/pokemontools/vba/autoplayer.py b/pokemontools/vba/autoplayer.py
index 428b85d..2d62433 100644
--- a/pokemontools/vba/autoplayer.py
+++ b/pokemontools/vba/autoplayer.py
@@ -70,12 +70,16 @@ class SpeedRunner(Runner):
self.config = config
def setup(self):
+ """
+ Configure this ``Runner`` instance to contain a reference to an active
+ emulator session.
+ """
if not self.cry:
self.cry = _vba.crystal(config=self.config)
def main(self):
"""
- Start the game.
+ Main entry point for complete control of the game as the main player.
"""
# get past the opening sequence
self.skip_intro(skip=True)
@@ -548,6 +552,9 @@ class SpeedRunner(Runner):
self.cry.move("d")
def main():
+ """
+ Setup a basic ``SpeedRunner`` instance and then run the runner.
+ """
runner = SpeedRunner()
runner.setup()
return runner.main()