update docstrings about the switch prompt

2 files changed, 8 insertions, 2 deletions

diff --git a/pokemontools/vba/battle.py b/pokemontools/vba/battle.py
index 17c0d5d..a5d9d52 100644
--- a/pokemontools/vba/battle.py
+++ b/pokemontools/vba/battle.py
@@ -58,7 +58,9 @@ class Battle(EmulatorController):
     def is_switch_prompt(self):
         """
         Detects if the battle is waiting for the player to choose whether or
-        not to switch pokemon.
+        not to switch pokemon. This is the prompt that asks yes/no for whether
+        to switch pokemon, like if the trainer is switching pokemon at the end
+        of a turn set.
         """
         return self.emulator.is_battle_switch_prompt()
 
diff --git a/pokemontools/vba/vba.py b/pokemontools/vba/vba.py
index 79eb77e..58ed1bd 100644
--- a/pokemontools/vba/vba.py
+++ b/pokemontools/vba/vba.py
@@ -602,8 +602,12 @@ class crystal(object):
     def is_battle_switch_prompt(self):
         """
         Checks if the game is currently displaying the yes/no prompt for
-        whether or not to switch pokemon.
+        whether or not to switch pokemon. This happens when the trainer is
+        switching pokemon out.
         """
+        # TODO: this method should return False if the game options have been
+        # set to not use the battle switching style.
+
         # get on-screen text
         text = self.get_text()