Added some changed to sections in docs.

praekeltfoundation · Feb 5, 2016 · 0595d9d · 0595d9d
1 parent 6723b4b
commit 0595d9d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/docs/sphinxcontrib/__init__.pyc b/docs/sphinxcontrib/__init__.pyc
diff --git a/docs/sphinxcontrib/autojs.pyc b/docs/sphinxcontrib/autojs.pyc
diff --git a/src/app.js b/src/app.js
@@ -514,6 +514,8 @@ go.app = function() {
 
         /**:function: getProvinceData(section_id, section_name)
 
+                Lists the provincial codes and names. Calls the getHttp function and returns a 
+                promise of data for the catagory selected for all provinces queried.
         */
 
         function getProvinceData(section_id, section_name) {
@@ -537,7 +539,13 @@ go.app = function() {
 //functions for fetching specific section data
 
         /**:function: provincial_section(data, section_id, section_name)
+                
+                Returns a subsection of data received from the json query for the relevant province.
+                We need to navigate through the json query to access specific results.::
 
+                    eg. sub_section.demographics = function(data) {
+                            return "Population: " + data.total_population.values.this;
+                        }    
         */
 
         function provincial_section(data, section_id, section_name) {