This PR adds missing docstrings to the NodeParser and handleOpenAIStream files in the packages/core/src directory. The docstrings follow the existing style used in the project and provide a brief description of the functions and classes, their parameters, return values, and any exceptions they might throw. For complex functions, examples are included to illustrate their usage.
Summary of Changes
Added docstrings to the getTextSplitsFromDocument function in NodeParser.ts
Added docstrings to the getNodesFromDocument function in NodeParser.ts
Added docstrings to the NodeParser interface in NodeParser.ts
Added docstrings to the SimpleNodeParser class in NodeParser.ts
Added a docstring to the handleOpenAIStream function in handleOpenAIStream.ts
Please review the changes and let me know if any further modifications are required.
Fixes #10.
To checkout this PR branch, run the following command in your terminal:
Description
This PR adds missing docstrings to the
NodeParserandhandleOpenAIStreamfiles in thepackages/core/srcdirectory. The docstrings follow the existing style used in the project and provide a brief description of the functions and classes, their parameters, return values, and any exceptions they might throw. For complex functions, examples are included to illustrate their usage.Summary of Changes
getTextSplitsFromDocumentfunction inNodeParser.tsgetNodesFromDocumentfunction inNodeParser.tsNodeParserinterface inNodeParser.tsSimpleNodeParserclass inNodeParser.tshandleOpenAIStreamfunction inhandleOpenAIStream.tsPlease review the changes and let me know if any further modifications are required.
Fixes #10.
To checkout this PR branch, run the following command in your terminal: