Add comment to the get_ranks function.

[xonotic/xonstat.git] / xonstat / views / main.py

diff --git a/xonstat/views/main.py b/xonstat/views/main.py
index 885110f8cb0b164bf566cd2cdaaddd298128b69f..dfaa5ee6926f2f7fbe709b041c28edd7974090ad 100644 (file)
--- a/xonstat/views/main.py
+++ b/xonstat/views/main.py
@@ -68,6 +68,10 @@ def get_summary_stats():
 @cache_region('hourly_term')
 def get_ranks(game_type_cd):
     """
+    Gets a set number of the top-ranked people for the specified game_type_cd.
+
+    The game_type_cd parameter is the type to fetch. Currently limited to
+    duel, dm, ctf, and tdm.
     """
     # how many ranks we want to fetch
     leaderboard_count = 10