refactor: markdownlint (#32259)

This commit is contained in:
Mason Daugherty 2025-07-27 20:00:16 -04:00 committed by GitHub
parent eafab52483
commit 53d0bfe9cd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 123 additions and 118 deletions

View File

@ -5,23 +5,28 @@ This project includes a [dev container](https://containers.dev/), which lets you
You can use the dev container configuration in this folder to build and run the app without needing to install any of its tools locally! You can use it in [GitHub Codespaces](https://github.com/features/codespaces) or the [VS Code Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). You can use the dev container configuration in this folder to build and run the app without needing to install any of its tools locally! You can use it in [GitHub Codespaces](https://github.com/features/codespaces) or the [VS Code Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
## GitHub Codespaces ## GitHub Codespaces
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/langchain-ai/langchain) [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/langchain-ai/langchain)
You may use the button above, or follow these steps to open this repo in a Codespace: You may use the button above, or follow these steps to open this repo in a Codespace:
1. Click the **Code** drop-down menu at the top of https://github.com/langchain-ai/langchain.
1. Click the **Code** drop-down menu at the top of <https://github.com/langchain-ai/langchain>.
1. Click on the **Codespaces** tab. 1. Click on the **Codespaces** tab.
1. Click **Create codespace on master**. 1. Click **Create codespace on master**.
For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace). For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace).
## VS Code Dev Containers ## VS Code Dev Containers
[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/langchain-ai/langchain) [![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/langchain-ai/langchain)
Note: If you click the link above you will open the main repo (langchain-ai/langchain) and not your local cloned repo. This is fine if you only want to run and test the library, but if you want to contribute you can use the link below and replace with your username and cloned repo name: Note: If you click the link above you will open the main repo (langchain-ai/langchain) and not your local cloned repo. This is fine if you only want to run and test the library, but if you want to contribute you can use the link below and replace with your username and cloned repo name:
``` ```
https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/<yourusername>/<yourclonedreponame> https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/<yourusername>/<yourclonedreponame>
``` ```
Then you will have a local cloned repo where you can contribute and then create pull requests. Then you will have a local cloned repo where you can contribute and then create pull requests.
If you already have VS Code and Docker installed, you can use the button above to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. If you already have VS Code and Docker installed, you can use the button above to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
@ -40,5 +45,5 @@ You can learn more in the [Dev Containers documentation](https://code.visualstud
## Tips and tricks ## Tips and tricks
* If you are working with the same repository folder in a container and Windows, you'll want consistent line endings (otherwise you may see hundreds of changes in the SCM view). The `.gitattributes` file in the root of this repo will disable line ending conversion and should prevent this. See [tips and tricks](https://code.visualstudio.com/docs/devcontainers/tips-and-tricks#_resolving-git-line-ending-issues-in-containers-resulting-in-many-modified-files) for more info. - If you are working with the same repository folder in a container and Windows, you'll want consistent line endings (otherwise you may see hundreds of changes in the SCM view). The `.gitattributes` file in the root of this repo will disable line ending conversion and should prevent this. See [tips and tricks](https://code.visualstudio.com/docs/devcontainers/tips-and-tricks#_resolving-git-line-ending-issues-in-containers-resulting-in-many-modified-files) for more info.
* If you'd like to review the contents of the image used in this dev container, you can check it out in the [devcontainers/images](https://github.com/devcontainers/images/tree/main/src/python) repo. - If you'd like to review the contents of the image used in this dev container, you can check it out in the [devcontainers/images](https://github.com/devcontainers/images/tree/main/src/python) repo.

View File

@ -1,111 +1,111 @@
repos: repos:
- repo: local - repo: local
hooks: hooks:
- id: core - id: core
name: format core name: format core
language: system language: system
entry: make -C libs/core format entry: make -C libs/core format
files: ^libs/core/ files: ^libs/core/
pass_filenames: false pass_filenames: false
- id: langchain - id: langchain
name: format langchain name: format langchain
language: system language: system
entry: make -C libs/langchain format entry: make -C libs/langchain format
files: ^libs/langchain/ files: ^libs/langchain/
pass_filenames: false pass_filenames: false
- id: standard-tests - id: standard-tests
name: format standard-tests name: format standard-tests
language: system language: system
entry: make -C libs/standard-tests format entry: make -C libs/standard-tests format
files: ^libs/standard-tests/ files: ^libs/standard-tests/
pass_filenames: false pass_filenames: false
- id: text-splitters - id: text-splitters
name: format text-splitters name: format text-splitters
language: system language: system
entry: make -C libs/text-splitters format entry: make -C libs/text-splitters format
files: ^libs/text-splitters/ files: ^libs/text-splitters/
pass_filenames: false pass_filenames: false
- id: anthropic - id: anthropic
name: format partners/anthropic name: format partners/anthropic
language: system language: system
entry: make -C libs/partners/anthropic format entry: make -C libs/partners/anthropic format
files: ^libs/partners/anthropic/ files: ^libs/partners/anthropic/
pass_filenames: false pass_filenames: false
- id: chroma - id: chroma
name: format partners/chroma name: format partners/chroma
language: system language: system
entry: make -C libs/partners/chroma format entry: make -C libs/partners/chroma format
files: ^libs/partners/chroma/ files: ^libs/partners/chroma/
pass_filenames: false pass_filenames: false
- id: couchbase - id: couchbase
name: format partners/couchbase name: format partners/couchbase
language: system language: system
entry: make -C libs/partners/couchbase format entry: make -C libs/partners/couchbase format
files: ^libs/partners/couchbase/ files: ^libs/partners/couchbase/
pass_filenames: false pass_filenames: false
- id: exa - id: exa
name: format partners/exa name: format partners/exa
language: system language: system
entry: make -C libs/partners/exa format entry: make -C libs/partners/exa format
files: ^libs/partners/exa/ files: ^libs/partners/exa/
pass_filenames: false pass_filenames: false
- id: fireworks - id: fireworks
name: format partners/fireworks name: format partners/fireworks
language: system language: system
entry: make -C libs/partners/fireworks format entry: make -C libs/partners/fireworks format
files: ^libs/partners/fireworks/ files: ^libs/partners/fireworks/
pass_filenames: false pass_filenames: false
- id: groq - id: groq
name: format partners/groq name: format partners/groq
language: system language: system
entry: make -C libs/partners/groq format entry: make -C libs/partners/groq format
files: ^libs/partners/groq/ files: ^libs/partners/groq/
pass_filenames: false pass_filenames: false
- id: huggingface - id: huggingface
name: format partners/huggingface name: format partners/huggingface
language: system language: system
entry: make -C libs/partners/huggingface format entry: make -C libs/partners/huggingface format
files: ^libs/partners/huggingface/ files: ^libs/partners/huggingface/
pass_filenames: false pass_filenames: false
- id: mistralai - id: mistralai
name: format partners/mistralai name: format partners/mistralai
language: system language: system
entry: make -C libs/partners/mistralai format entry: make -C libs/partners/mistralai format
files: ^libs/partners/mistralai/ files: ^libs/partners/mistralai/
pass_filenames: false pass_filenames: false
- id: nomic - id: nomic
name: format partners/nomic name: format partners/nomic
language: system language: system
entry: make -C libs/partners/nomic format entry: make -C libs/partners/nomic format
files: ^libs/partners/nomic/ files: ^libs/partners/nomic/
pass_filenames: false pass_filenames: false
- id: ollama - id: ollama
name: format partners/ollama name: format partners/ollama
language: system language: system
entry: make -C libs/partners/ollama format entry: make -C libs/partners/ollama format
files: ^libs/partners/ollama/ files: ^libs/partners/ollama/
pass_filenames: false pass_filenames: false
- id: openai - id: openai
name: format partners/openai name: format partners/openai
language: system language: system
entry: make -C libs/partners/openai format entry: make -C libs/partners/openai format
files: ^libs/partners/openai/ files: ^libs/partners/openai/
pass_filenames: false pass_filenames: false
- id: prompty - id: prompty
name: format partners/prompty name: format partners/prompty
language: system language: system
entry: make -C libs/partners/prompty format entry: make -C libs/partners/prompty format
files: ^libs/partners/prompty/ files: ^libs/partners/prompty/
pass_filenames: false pass_filenames: false
- id: qdrant - id: qdrant
name: format partners/qdrant name: format partners/qdrant
language: system language: system
entry: make -C libs/partners/qdrant format entry: make -C libs/partners/qdrant format
files: ^libs/partners/qdrant/ files: ^libs/partners/qdrant/
pass_filenames: false pass_filenames: false
- id: root - id: root
name: format docs, cookbook name: format docs, cookbook
language: system language: system
entry: make format entry: make format
files: ^(docs|cookbook)/ files: ^(docs|cookbook)/
pass_filenames: false pass_filenames: false

View File

@ -13,7 +13,7 @@ build:
# Build documentation in the docs/ directory with Sphinx # Build documentation in the docs/ directory with Sphinx
sphinx: sphinx:
configuration: docs/api_reference/conf.py configuration: docs/api_reference/conf.py
# If using Sphinx, optionally build your docs in additional formats such as PDF # If using Sphinx, optionally build your docs in additional formats such as PDF
formats: formats:
@ -21,5 +21,5 @@ formats:
# Optionally declare the Python requirements required to build your docs # Optionally declare the Python requirements required to build your docs
python: python:
install: install:
- requirements: docs/api_reference/requirements.txt - requirements: docs/api_reference/requirements.txt

View File

@ -7,5 +7,5 @@ Please see the following guides for migrating LangChain code:
* Migrating from [LangChain 0.0.x Chains](https://python.langchain.com/docs/versions/migrating_chains/) * Migrating from [LangChain 0.0.x Chains](https://python.langchain.com/docs/versions/migrating_chains/)
* Upgrade to [LangGraph Memory](https://python.langchain.com/docs/versions/migrating_memory/) * Upgrade to [LangGraph Memory](https://python.langchain.com/docs/versions/migrating_memory/)
The [LangChain CLI](https://python.langchain.com/docs/versions/v0_3/#migrate-using-langchain-cli) can help you automatically upgrade your code to use non-deprecated imports. The [LangChain CLI](https://python.langchain.com/docs/versions/v0_3/#migrate-using-langchain-cli) can help you automatically upgrade your code to use non-deprecated imports.
This will be especially helpful if you're still on either version 0.0.x or 0.1.x of LangChain. This will be especially helpful if you're still on either version 0.0.x or 0.1.x of LangChain.