From 02495ae7c5d4970b1b018f1bb5f11300f4ae3e65 Mon Sep 17 00:00:00 2001 From: Suganth Solamanraja Date: Thu, 6 Jun 2024 20:21:46 +0530 Subject: [PATCH] docs: Correct return type in docstring (#22597) Thank you for contributing to LangChain! - [x] **PR title**: "package: description" - Where "package" is whichever of langchain, community, core, experimental, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes. - Example: "community: add foobar LLM" - [x] **PR message**: - **Description:** This PR corrects the return type in the docstring of the `docs/api_reference/create_api_rst.py/_load_package_modules` function. The return type was previously described as a list of Co-authored-by: suganthsolamanraja --- docs/api_reference/create_api_rst.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api_reference/create_api_rst.py b/docs/api_reference/create_api_rst.py index 504d71a5b9..f957452f17 100644 --- a/docs/api_reference/create_api_rst.py +++ b/docs/api_reference/create_api_rst.py @@ -128,11 +128,11 @@ def _load_package_modules( of the modules/packages are part of the package vs. 3rd party or built-in. Parameters: - package_directory: Path to the package directory. - submodule: Optional name of submodule to load. + package_directory (Union[str, Path]): Path to the package directory. + submodule (Optional[str]): Optional name of submodule to load. Returns: - list: A list of loaded module objects. + Dict[str, ModuleMembers]: A dictionary where keys are module names and values are ModuleMembers objects. """ package_path = ( Path(package_directory)