Update jsdoc in reader

Author: risenW

danfojs-browser/src/io/reader.js

@@ -5,10 +5,15 @@ import { DataFrame } from "../core/frame";
 
 /**
  * Reads a CSV file from local or remote storage
- *
- * @param {source} URL to CSV file
- * @param {config} (Optional). A CSV Config object that contains configurations
+ * @param {string} source URL to CSV file
+ * @param {object} config (Optional). A CSV Config object that contains configurations
  *     for reading and decoding from CSV file(s).
+ *                { start: The index position to start from when reading the CSV file.
+ *
+ *                end: The end position to stop at when reading the CSV file.
+ *
+ *                ...csvConfigs: other supported Tensorflow csvConfig parameters. See https://js.tensorflow.org/api/latest/#data.csv 
+ *                }
  *
  * @returns {Promise} DataFrame structure of parsed CSV data
  */
@@ -30,8 +35,7 @@ export const read_csv = async (source, configs = {}) => {
 
 /**
  * Reads a JSON file from local or remote address
- *
- * @param {source} URL or local file path to retreive JSON file.
+ * @param {string} source URL or local file path to retreive JSON file.
  * @returns {Promise} DataFrame structure of parsed CSV data
  */
 export const read_json = async (source) => {
@@ -44,12 +48,15 @@ export const read_json = async (source) => {
 
 /**
  * Reads an Excel file from local or remote address
+ * @param {string} source URL to Excel file
+ * @param {object} configs {
+ *
+ *                        sheet : string, (Optional) Name of the sheet which u want to parse. Default will be the first sheet.
  *
- *  * @param {kwargs} kwargs --> {
- *                        source       : string, URL or local file path to retreive Excel file.
- *                        sheet   : string, (Optional) Name of the sheet which u want to parse. Default will be the first sheet.
  *                        header_index : int, (Optional) Index of the row which represents the header(columns) of the data. Default will be the first non empty row.
- *                        data_index   : int, (Optional)Index of the row from which actual data(content) starts. Default will be the next row of `header_index`
+ *
+ *                        data_index   : int, (Optional) Index of the row from which actual data(content) starts. Default will be the next row of `header_index`.
+ *
  *                    }
  * @returns {Promise} DataFrame structure of parsed Excel data
  */

danfojs-node/src/io/reader.js

@@ -65,9 +65,10 @@ export const read_json = async (source) => {
 
 /**
  * Reads an Excel file from local or remote address
- *  * @param {kwargs} kwargs --> {
- *                     source : string, URL or local file path to retreive Excel file
- *                     configs: object, (Optional) {
+ * @param {string} source URL or local file path to retreive Excel file.
+ * @param {object} configs (Optional) Configuration options when reading excel files
+ *
+ *                          {
  *                            sheet  : string, (Optional) number of the sheet to parse. Default will be the first sheet.
  *                          }
  * @returns {Promise} DataFrame structure of parsed Excel data
@@ -79,33 +80,38 @@ export const read_excel = async (source, configs) => {
 
 /**
  * Opens a file using frictionless.js specification.
- * @param {string} pathOrDescriptor A path to the file/resources. It can be a local file,
+ * @param {string} source A path to the file/resources. It can be a local file,
  * a URL to a tabular data (CSV, EXCEL) or Datahub.io Data Resource.
  * Data comes with extra properties and specification conforming to the Frictionless Data standards.
- * @param {object} configs { data_num (Defaults => 0): The specific dataset to load, when reading data from a datapackage.json,
- *                          header (Defaults => true): Whether the dataset contains header or not.
- *                          }
+ * @param {object} configs {
+ *
+ *                  data_num (Defaults => 0): The specific dataset to load, when reading data from a datapackage.json
+ *
+ *                  header (Defaults => true): Whether the dataset contains header or not.
+ *
+ *                  sheet (Defaults => 0): Number of the excel sheet which u want to load.
+ *                 }
  * @returns {DataFrame} Danfo DataFrame/Series
  */
 export const read = async (
-  path_or_descriptor,
+  source,
   configs = {}
 ) => {
   let { data_num, header, sheet } = configs;
   data_num = data_num === undefined ? 0 : data_num;
   header = header === undefined ? true : header;
   let rows, file;
 
-  if (isDataset(path_or_descriptor)) {
+  if (isDataset(source)) {
     console.log(
       "datapackage.json found. Loading Dataset package from Datahub.io"
     );
-    const dataset = await Dataset.load(path_or_descriptor);
+    const dataset = await Dataset.load(source);
     file = dataset.resources[data_num];
     rows = await toArray(await file.rows());
   } else {
     try {
-      file = open(path_or_descriptor);
+      file = open(source);
       if (sheet) {
         rows = await toArray(await file.rows({ sheet }));
       } else {