This PR adds missing docstrings to the NodeParser.ts and handleOpenAIStream.ts files in the packages/core/src directory. The docstrings provide a concise and clear 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 docstring to the getTextSplitsFromDocument function in NodeParser.ts
Added docstring to the getNodesFromDocument function in NodeParser.ts
Added docstring to the NodeParser interface in NodeParser.ts
Added docstring to the SimpleNodeParser class in NodeParser.ts, including an example of how to use it
Added docstring to the handleOpenAIStream function in handleOpenAIStream.ts, including an example of how to use it
These changes improve the codebase by providing clear and concise documentation for the functions and classes in these files, making it easier for other developers to understand and use the code.
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 concise and clear 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.ts, including an example of how to use ithandleOpenAIStreamfunction inhandleOpenAIStream.ts, including an example of how to use itThese changes improve the codebase by providing clear and concise documentation for the functions and classes in these files, making it easier for other developers to understand and use the code.
Fixes #10.
To checkout this PR branch, run the following command in your terminal: