This PR adds missing docstrings to the NodeParser.ts and handleOpenAIStream.ts files in the packages/core/src directory. The docstrings provide a brief description of the functions and classes, their parameters, return values, and any side effects. 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 class in NodeParser.ts
Added docstrings to the SimpleNodeParser class in NodeParser.ts
Added a docstring to the handleOpenAIStream function in handleOpenAIStream.ts
Please review and merge this PR to improve the documentation and maintain consistency in the project.
Fixes #10.
To checkout this PR branch, run the following command in your terminal:
Description
This PR adds missing docstrings to the
NodeParser.tsandhandleOpenAIStream.tsfiles in thepackages/core/srcdirectory. The docstrings provide a brief description of the functions and classes, their parameters, return values, and any side effects. For complex functions, examples are included to illustrate their usage.Summary of Changes
getTextSplitsFromDocumentfunction inNodeParser.tsgetNodesFromDocumentfunction inNodeParser.tsNodeParserclass inNodeParser.tsSimpleNodeParserclass inNodeParser.tshandleOpenAIStreamfunction inhandleOpenAIStream.tsPlease review and merge this PR to improve the documentation and maintain consistency in the project.
Fixes #10.
To checkout this PR branch, run the following command in your terminal: