From: Ant Zucaro <azucaro@gmail.com>
Date: Sun, 23 Dec 2012 13:49:34 +0000 (-0500)
Subject: Add comment to the get_ranks function.
X-Git-Url: https://de.git.xonotic.org/?a=commitdiff_plain;h=8aba5e0f12624486859b3feaad6fe414fd5fa564;hp=f5da795ffb658fddecd6b861769a71db248e4b43;p=xonotic%2Fxonstat.git

Add comment to the get_ranks function.
---

diff --git a/xonstat/views/main.py b/xonstat/views/main.py
index 885110f..dfaa5ee 100644
--- 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