From d7f90f233ba47886d8413e5713301296053a8e31 Mon Sep 17 00:00:00 2001 From: Tian Siyuan Date: Sun, 1 Jun 2025 01:55:07 +0800 Subject: [PATCH] fix a typo (#31447) Thank you for contributing to LangChain! - [ ] **PR title**: "package: description" - Where "package" is whichever of langchain, core, etc. is being modified. Use "docs: ..." for purely docs changes, "infra: ..." for CI changes. - Example: "core: add foobar LLM" - [ ] **PR message**: ***Delete this entire checklist*** and replace with - **Description:** a description of the change - **Issue:** the issue # it fixes, if applicable - **Dependencies:** any dependencies required for this change - **Twitter handle:** if your PR gets announced, and you'd like a mention, we'll gladly shout you out! - [ ] **Add tests and docs**: If you're adding a new integration, please include 1. a test for the integration, preferably unit tests that do not rely on network access, 2. an example notebook showing its use. It lives in `docs/docs/integrations` directory. - [ ] **Lint and test**: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified. See contribution guidelines for more: https://python.langchain.com/docs/contributing/ Additional guidelines: - Make sure optional dependencies are imported within a function. - Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests. - Most PRs should not touch more than one package. - Changes should be backwards compatible. If no one reviews your PR within a few days, please @-mention one of baskaryan, eyurtsev, ccurme, vbarda, hwchase17. --- docs/docs/contributing/how_to/documentation/style_guide.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/contributing/how_to/documentation/style_guide.mdx b/docs/docs/contributing/how_to/documentation/style_guide.mdx index 2eb20d68537..201285dd149 100644 --- a/docs/docs/contributing/how_to/documentation/style_guide.mdx +++ b/docs/docs/contributing/how_to/documentation/style_guide.mdx @@ -82,7 +82,7 @@ Here are some high-level tips on writing a good how-to guide: LangChain's conceptual guide falls under the **Explanation** quadrant of Diataxis. These guides should cover LangChain terms and concepts in a more abstract way than how-to guides or tutorials, targeting curious users interested in gaining a deeper understanding and insights of the framework. Try to avoid excessively large code examples as the primary goal is to -provide perspective to the user rather than to finish a practical project. These guides should cover **why** things work they way they do. +provide perspective to the user rather than to finish a practical project. These guides should cover **why** things work the way they do. This guide on documentation style is meant to fall under this category.