This PR adds missing docstrings to the NodeParser.ts and handleOpenAIStream.ts files in the packages/core/src directory. The docstrings provide a clear and concise explanation of the purpose and usage of the functions and classes in these files. The docstrings follow the existing style used in the project and include examples for complex functions.
Summary of Changes
Added docstrings to the getTextSplitsFromDocument function in NodeParser.ts. The docstring explains the purpose of the function, its parameters, return value, and provides an example.
Added docstrings to the getNodesFromDocument function in NodeParser.ts. The docstring explains the purpose of the function, its parameters, return value, and provides an example.
Added docstrings to the NodeParser interface in NodeParser.ts. The docstring explains the purpose of the interface.
Added docstrings to the SimpleNodeParser class in NodeParser.ts. The docstring explains the purpose of the class, its constructor parameters, and provides an example.
Added a docstring to the handleOpenAIStream function in handleOpenAIStream.ts. The docstring explains the purpose of the function, its parameters, return value, and provides an example.
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
NodeParser.tsandhandleOpenAIStream.tsfiles in thepackages/core/srcdirectory. The docstrings provide a clear and concise explanation of the purpose and usage of the functions and classes in these files. The docstrings follow the existing style used in the project and include examples for complex functions.Summary of Changes
getTextSplitsFromDocumentfunction inNodeParser.ts. The docstring explains the purpose of the function, its parameters, return value, and provides an example.getNodesFromDocumentfunction inNodeParser.ts. The docstring explains the purpose of the function, its parameters, return value, and provides an example.NodeParserinterface inNodeParser.ts. The docstring explains the purpose of the interface.SimpleNodeParserclass inNodeParser.ts. The docstring explains the purpose of the class, its constructor parameters, and provides an example.handleOpenAIStreamfunction inhandleOpenAIStream.ts. The docstring explains the purpose of the function, its parameters, return value, and provides an example.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: