Documentation updates

mlbgame/__init__.py

@@ -133,12 +133,15 @@
 
 from mlbgame import version
 VERSION = version.__version__
+'''
+Current version of mlbgame
+'''
 
 def day(year, month, day, home=None, away=None):
 	'''
-	Return an array of games for a certain day
+	Return a list of games for a certain day
 	
-	If home and away are the same, it will return the game for that team
+	If the home and away team are the same, it will return the game(s) for that team
 	'''
 	daysinmonth = calendar.monthrange(year, month)[1]
 	if daysinmonth < day:
@@ -159,7 +162,7 @@ def day(year, month, day, home=None, away=None):
 
 def games(years, months=None, days=None, home=None, away=None):
 	'''
-	Return an array of arrays of games for multiple days
+	Return a list of lists of games for multiple days
 	
 	If home and away are the same team, it will return all games for that team
 	'''

mlbgame/game.py

@@ -4,6 +4,11 @@
 import gzip
 
 def scoreboard(year, month, day, home=None, away=None):
+    '''
+    Return the data for a certain day matching certain criteria as a dictionary
+
+    Should not be used other than as called by `__init__.py`
+    '''
     monthstr = str(month).zfill(2)
     daystr = str(day).zfill(2)
     filename = "gameday-data/year_"+str(year)+"/month_"+monthstr+"/day_"+daystr+"/scoreboard.xml.gz"
@@ -67,9 +72,14 @@ def scoreboard(year, month, day, home=None, away=None):
 
 class GameScoreboard(object):
     '''
-    Object to hold information about a certain game
+    Object to hold scoreboard information about a certain game
     '''
     def __init__(self, data):
+        '''
+        Creates a `GameScoreboard` object
+
+        data is expected to come from the `scoreboard()` function
+        '''
         self.game_id = data['game_id']
         self.game_type = data.get('game_type', '')
         self.game_status = data.get('game_status', '')

mlbgame/version.py

@@ -1 +1,4 @@
-__version__="0.1.2"
+__version__="0.1.2"
+'''
+Current version of mlbgame
+'''