svn commit: r1711504 - /comdev/reporter.apache.org/trunk/site/getjson.py

[se...@apache.org]

Author: sebb
Date: Fri Oct 30 16:43:02 2015
New Revision: 1711504

URL: http://svn.apache.org/viewvc?rev=1711504&view=rev
Log:
Docs

Modified:
    comdev/reporter.apache.org/trunk/site/getjson.py

Modified: comdev/reporter.apache.org/trunk/site/getjson.py
URL: http://svn.apache.org/viewvc/comdev/reporter.apache.org/trunk/site/getjson.py?rev=1711504&r1=1711503&r2=1711504&view=diff
==============================================================================
--- comdev/reporter.apache.org/trunk/site/getjson.py (original)
+++ comdev/reporter.apache.org/trunk/site/getjson.py Fri Oct 30 16:43:02 2015
@@ -194,6 +194,18 @@ def getJIRAS(project):
 #                 json.dump([0,0,None], f, indent=1)
 #                 f.close()
             return 0,0, None
+"""
+Reads:
+ - PAOHOME+"site/json/projects/%s.json" % project
+ - PAOHOME+"site/json/foundation/pmcs.json"
+ - PAOHOME+"site/json/foundation/chairs.json"
+
+@return:
+ - contents of projects/%.json % project if it exists
+   in any case, dict contains pmc name & chair extracted from pmcs.json/chairs.json 
+ - list of project names in pmcs.json
+ - health entry from data/health.json
+"""
 
 def getProjectData(project):
     try:
@@ -235,7 +247,7 @@ def getProjectData(project):
         for entry in h:
             if entry['group'] == project:
                 z = entry
-        return x,y,z
+        return x, y, z;
 
 def getReleaseData(project):
     """Reads data/releases/%s.json and returns the contents"""