Skip to content

Commit ec268de

Browse files
committed
Update docstring for io functions
1 parent 86ecf62 commit ec268de

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

src/danfojs-base/io/node/io.csv.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ const $readCSV = async (filePath: string, options?: CsvInputOptionsNode): Promis
8888
* Streams a CSV file from local or remote location in chunks. Intermediate chunks is passed as a DataFrame to the callback function.
8989
* @param filePath URL or local file path to CSV file. `readCSV` uses PapaParse to parse the CSV file,
9090
* hence all PapaParse options are supported.
91-
* @param options Configuration object. Supports all Papaparse parse config options.
9291
* @param callback Callback function to be called once the specifed rows are parsed into DataFrame.
92+
* @param options Configuration object. Supports all Papaparse parse config options.
9393
* @example
9494
* ```
9595
* import { streamCSV } from "danfojs-node"

src/danfojs-base/io/node/io.json.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ const $readJSON = async (filePath: string, options: JsonInputOptionsNode = {}) =
6363
/**
6464
* Streams a JSON file from local or remote location in chunks. Intermediate chunks is passed as a DataFrame to the callback function.
6565
* @param filePath URL or local file path to CSV file.
66+
* @param callback Callback function to be called once the specifed rows are parsed into DataFrame.
6667
* @param options Configuration object. We use the `request` library for reading remote json files,
6768
* Hence all `request` parameters such as `method`, `headers`, are supported.
68-
* @param callback Callback function to be called once the specifed rows are parsed into DataFrame.
6969
* @example
7070
* ```
7171
* import { streamJSON } from "danfojs-node"
@@ -78,7 +78,6 @@ const $readJSON = async (filePath: string, options: JsonInputOptionsNode = {}) =
7878
const $streamJSON = async (
7979
filePath: string,
8080
callback: (df: DataFrame) => void,
81-
8281
options?: request.RequiredUriUrl & request.CoreOptions,
8382
) => {
8483
const { method, headers } = { method: "GET", headers: {}, ...options }

0 commit comments

Comments
 (0)