updated docs

OpenFn · Sep 6, 2017 · 7b1ede6 · 7b1ede6
1 parent 13ef5cb
commit 7b1ede6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 14 deletions.
diff --git a/lib/Adaptor.js b/lib/Adaptor.js
@@ -106,13 +106,13 @@ function execute() {
 /**
  * Fetch a dataValueSet
  * @example
- * execute(
- *   fetchData(dataSetId, period, orgUnit)
- * )(state)
+ * execute({
+ *   dataSet: 'pBOMPrpg1QX',
+ *   orgUnit: 'DiszpKrYNg8',
+ *   period: '201401'
+ * })(state)
  * @constructor
- * @param {string} dataSet - data set ID
- * @param {string} period - period code
- * @param {string} orgUnit - org unit ID
+ * @param {object} params - data to query for events
  * @returns {Operation}
  */
 function fetchData(params) {
@@ -153,7 +153,6 @@ function fetchData(params) {
         });
       }
     });
-    // https://docs.dhis2.org/2.22/en/developer/html/ch01s13.html#d5e1642
   };
 };
 
@@ -205,7 +204,6 @@ function fetchEvents(params) {
         });
       }
     });
-    // https://docs.dhis2.org/2.22/en/developer/html/ch01s15.html#d5e1994
   };
 };
 

diff --git a/src/Adaptor.js b/src/Adaptor.js
@@ -42,13 +42,13 @@ export function execute(...operations) {
 /**
  * Fetch a dataValueSet
  * @example
- * execute(
- *   fetchData(dataSetId, period, orgUnit)
- * )(state)
+ * execute({
+ *   dataSet: 'pBOMPrpg1QX',
+ *   orgUnit: 'DiszpKrYNg8',
+ *   period: '201401'
+ * })(state)
  * @constructor
- * @param {string} dataSet - data set ID
- * @param {string} period - period code
- * @param {string} orgUnit - org unit ID
+ * @param {object} params - data to query for events
  * @returns {Operation}
  */
 export function fetchData(params) {