From e13cdeab1104260e2dcfd04aa9dbaa5688f357d0 Mon Sep 17 00:00:00 2001
From: Bryan Bishop <kanzure@gmail.com>
Date: Sat, 12 Oct 2013 16:33:52 -0500
Subject: another minor docstring

---
 pokemontools/vba/vba.py | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'pokemontools/vba/vba.py')

diff --git a/pokemontools/vba/vba.py b/pokemontools/vba/vba.py
index e30616f..81b27a3 100644
--- a/pokemontools/vba/vba.py
+++ b/pokemontools/vba/vba.py
@@ -29,6 +29,10 @@ button_masks = vba_wrapper.core.VBA.button_masks
 button_combiner = vba_wrapper.core.VBA.button_combine
 
 def translate_chars(charz):
+    """
+    Translate a string from the in-game format to readable form. This is
+    accomplished through the same lookup table that the preprocessors use.
+    """
     result = ""
     for each in charz:
         result += chars[each]
-- 
cgit v1.2.3