update inline doc

OpenFn · May 14, 2021 · f6f58f3 · f6f58f3
1 parent bda347e
commit f6f58f3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 11 deletions.
diff --git a/lib/Adaptor.js b/lib/Adaptor.js
@@ -86,8 +86,6 @@ var _superagent = _interopRequireDefault(require("superagent"));
 
 var _formData = _interopRequireDefault(require("form-data"));
 
-var _url = require("url");
-
 var _js2xmlparser = _interopRequireDefault(require("js2xmlparser"));
 
 var _languageHttp = _interopRequireDefault(require("language-http"));
@@ -106,7 +104,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  *   create('foo'),
  *   delete('bar')
  * )(state)
- * @function
+ * @constructor
  * @param {Operations} operations - Operations to be performed.
  * @returns {Operation}
  */
@@ -127,7 +125,7 @@ function execute(...operations) {
  * Performs a post request
  * @example
  *  clientPost(formData)
- * @function
+ * @constructor
  * @param {Object} formData - Form Data with auth params and body
  * @returns {State}
  */
@@ -285,11 +283,11 @@ function submit(formData) {
   };
 }
 /**
- * Make a GET request to CommCare's Reports Api
+ * Make a GET request to CommCare's Reports API
  * and POST the response to somewhere else.
  * @public
  * @example
- *  fetchReportData(reportId, params, postUrl)
+ * fetchReportData(reportId, params, postUrl)
  * @constructor
  * @param {String} reportId - API name of the report.
  * @param {Object} params - Query params, incl: limit, offset, and custom report filters.

diff --git a/src/Adaptor.js b/src/Adaptor.js
@@ -7,7 +7,6 @@ import {
 } from '@openfn/language-common';
 import request from 'superagent';
 import FormData from 'form-data';
-import { resolve as resolveUrl } from 'url';
 import js2xmlparser from 'js2xmlparser';
 import Adaptor from 'language-http';
 import xlsx from 'xlsx';
@@ -20,7 +19,7 @@ import xlsx from 'xlsx';
  *   create('foo'),
  *   delete('bar')
  * )(state)
- * @function
+ * @constructor
  * @param {Operations} operations - Operations to be performed.
  * @returns {Operation}
  */
@@ -43,7 +42,7 @@ export function execute(...operations) {
  * Performs a post request
  * @example
  *  clientPost(formData)
- * @function
+ * @constructor
  * @param {Object} formData - Form Data with auth params and body
  * @returns {State}
  */
@@ -194,11 +193,11 @@ export function submit(formData) {
 }
 
 /**
- * Make a GET request to CommCare's Reports Api
+ * Make a GET request to CommCare's Reports API
  * and POST the response to somewhere else.
  * @public
  * @example
- *  fetchReportData(reportId, params, postUrl)
+ * fetchReportData(reportId, params, postUrl)
  * @constructor
  * @param {String} reportId - API name of the report.
  * @param {Object} params - Query params, incl: limit, offset, and custom report filters.