Skip to content

Commit 8c9c23b

Browse files
committed
Improves JSDoc for parseCSV
1 parent 5286476 commit 8c9c23b

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

docs/util/util.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ parseCSV - Parses a CSV file into a hierarchy structure.
2727
| Param | Type | Description |
2828
| --- | --- | --- |
2929
| csvFilePath | <code>string</code> | Path to CSV file to be parsed. |
30-
| attributeFields | <code>array.&lt;string&gt;</code> OR <code>undefined</code> | Set of `link` fields to be used as attributes |
30+
| attributeFields | <code>array.&lt;string&gt;</code> OR <code>undefined</code> | Set of column names to be used as attributes (optional) |
3131

3232
<a name="parseJSON"></a>
3333

@@ -66,3 +66,4 @@ a flat array of links.
6666
| Param | Type | Description |
6767
| --- | --- | --- |
6868
| flatArray | <code>array.&lt;object&gt;</code> | Flat array of `link` objects |
69+

src/util/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ function _transformToHierarchy(links, attributeFields) {
6767
* parseCSV - Parses a CSV file into a hierarchy structure.
6868
*
6969
* @param {string} csvFilePath Path to CSV file to be parsed.
70-
* @param {array<string>|undefined} attributeFields Set of `link` fields to be used as attributes
70+
* @param {array<string>|undefined} attributeFields Set of column names to be used as attributes (optional)
7171
*
7272
* @return {Promise} Returns hierarchy array if resolved, error object if rejected.
7373
*/

0 commit comments

Comments
 (0)