Skip to content

Commit 53d0bfe

Browse files
authored
refactor: markdownlint (#32259)
1 parent eafab52 commit 53d0bfe

File tree

4 files changed

+123
-118
lines changed

4 files changed

+123
-118
lines changed

.devcontainer/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,28 @@ This project includes a [dev container](https://containers.dev/), which lets you
55
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).
66

77
## GitHub Codespaces
8+
89
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/langchain-ai/langchain)
910

1011
You may use the button above, or follow these steps to open this repo in a Codespace:
11-
1. Click the **Code** drop-down menu at the top of https://github.com/langchain-ai/langchain.
12+
13+
1. Click the **Code** drop-down menu at the top of <https://github.com/langchain-ai/langchain>.
1214
1. Click on the **Codespaces** tab.
1315
1. Click **Create codespace on master**.
1416

1517
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).
1618

1719
## VS Code Dev Containers
20+
1821
[![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)
1922

20-
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:
23+
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:
24+
2125
```
2226
https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/<yourusername>/<yourclonedreponame>
2327
2428
```
29+
2530
Then you will have a local cloned repo where you can contribute and then create pull requests.
2631

2732
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
4045

4146
## Tips and tricks
4247

43-
* 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.
44-
* 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.
48+
- 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.
49+
- 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.

.pre-commit-config.yaml

Lines changed: 110 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,111 @@
11
repos:
2-
- repo: local
3-
hooks:
4-
- id: core
5-
name: format core
6-
language: system
7-
entry: make -C libs/core format
8-
files: ^libs/core/
9-
pass_filenames: false
10-
- id: langchain
11-
name: format langchain
12-
language: system
13-
entry: make -C libs/langchain format
14-
files: ^libs/langchain/
15-
pass_filenames: false
16-
- id: standard-tests
17-
name: format standard-tests
18-
language: system
19-
entry: make -C libs/standard-tests format
20-
files: ^libs/standard-tests/
21-
pass_filenames: false
22-
- id: text-splitters
23-
name: format text-splitters
24-
language: system
25-
entry: make -C libs/text-splitters format
26-
files: ^libs/text-splitters/
27-
pass_filenames: false
28-
- id: anthropic
29-
name: format partners/anthropic
30-
language: system
31-
entry: make -C libs/partners/anthropic format
32-
files: ^libs/partners/anthropic/
33-
pass_filenames: false
34-
- id: chroma
35-
name: format partners/chroma
36-
language: system
37-
entry: make -C libs/partners/chroma format
38-
files: ^libs/partners/chroma/
39-
pass_filenames: false
40-
- id: couchbase
41-
name: format partners/couchbase
42-
language: system
43-
entry: make -C libs/partners/couchbase format
44-
files: ^libs/partners/couchbase/
45-
pass_filenames: false
46-
- id: exa
47-
name: format partners/exa
48-
language: system
49-
entry: make -C libs/partners/exa format
50-
files: ^libs/partners/exa/
51-
pass_filenames: false
52-
- id: fireworks
53-
name: format partners/fireworks
54-
language: system
55-
entry: make -C libs/partners/fireworks format
56-
files: ^libs/partners/fireworks/
57-
pass_filenames: false
58-
- id: groq
59-
name: format partners/groq
60-
language: system
61-
entry: make -C libs/partners/groq format
62-
files: ^libs/partners/groq/
63-
pass_filenames: false
64-
- id: huggingface
65-
name: format partners/huggingface
66-
language: system
67-
entry: make -C libs/partners/huggingface format
68-
files: ^libs/partners/huggingface/
69-
pass_filenames: false
70-
- id: mistralai
71-
name: format partners/mistralai
72-
language: system
73-
entry: make -C libs/partners/mistralai format
74-
files: ^libs/partners/mistralai/
75-
pass_filenames: false
76-
- id: nomic
77-
name: format partners/nomic
78-
language: system
79-
entry: make -C libs/partners/nomic format
80-
files: ^libs/partners/nomic/
81-
pass_filenames: false
82-
- id: ollama
83-
name: format partners/ollama
84-
language: system
85-
entry: make -C libs/partners/ollama format
86-
files: ^libs/partners/ollama/
87-
pass_filenames: false
88-
- id: openai
89-
name: format partners/openai
90-
language: system
91-
entry: make -C libs/partners/openai format
92-
files: ^libs/partners/openai/
93-
pass_filenames: false
94-
- id: prompty
95-
name: format partners/prompty
96-
language: system
97-
entry: make -C libs/partners/prompty format
98-
files: ^libs/partners/prompty/
99-
pass_filenames: false
100-
- id: qdrant
101-
name: format partners/qdrant
102-
language: system
103-
entry: make -C libs/partners/qdrant format
104-
files: ^libs/partners/qdrant/
105-
pass_filenames: false
106-
- id: root
107-
name: format docs, cookbook
108-
language: system
109-
entry: make format
110-
files: ^(docs|cookbook)/
111-
pass_filenames: false
2+
- repo: local
3+
hooks:
4+
- id: core
5+
name: format core
6+
language: system
7+
entry: make -C libs/core format
8+
files: ^libs/core/
9+
pass_filenames: false
10+
- id: langchain
11+
name: format langchain
12+
language: system
13+
entry: make -C libs/langchain format
14+
files: ^libs/langchain/
15+
pass_filenames: false
16+
- id: standard-tests
17+
name: format standard-tests
18+
language: system
19+
entry: make -C libs/standard-tests format
20+
files: ^libs/standard-tests/
21+
pass_filenames: false
22+
- id: text-splitters
23+
name: format text-splitters
24+
language: system
25+
entry: make -C libs/text-splitters format
26+
files: ^libs/text-splitters/
27+
pass_filenames: false
28+
- id: anthropic
29+
name: format partners/anthropic
30+
language: system
31+
entry: make -C libs/partners/anthropic format
32+
files: ^libs/partners/anthropic/
33+
pass_filenames: false
34+
- id: chroma
35+
name: format partners/chroma
36+
language: system
37+
entry: make -C libs/partners/chroma format
38+
files: ^libs/partners/chroma/
39+
pass_filenames: false
40+
- id: couchbase
41+
name: format partners/couchbase
42+
language: system
43+
entry: make -C libs/partners/couchbase format
44+
files: ^libs/partners/couchbase/
45+
pass_filenames: false
46+
- id: exa
47+
name: format partners/exa
48+
language: system
49+
entry: make -C libs/partners/exa format
50+
files: ^libs/partners/exa/
51+
pass_filenames: false
52+
- id: fireworks
53+
name: format partners/fireworks
54+
language: system
55+
entry: make -C libs/partners/fireworks format
56+
files: ^libs/partners/fireworks/
57+
pass_filenames: false
58+
- id: groq
59+
name: format partners/groq
60+
language: system
61+
entry: make -C libs/partners/groq format
62+
files: ^libs/partners/groq/
63+
pass_filenames: false
64+
- id: huggingface
65+
name: format partners/huggingface
66+
language: system
67+
entry: make -C libs/partners/huggingface format
68+
files: ^libs/partners/huggingface/
69+
pass_filenames: false
70+
- id: mistralai
71+
name: format partners/mistralai
72+
language: system
73+
entry: make -C libs/partners/mistralai format
74+
files: ^libs/partners/mistralai/
75+
pass_filenames: false
76+
- id: nomic
77+
name: format partners/nomic
78+
language: system
79+
entry: make -C libs/partners/nomic format
80+
files: ^libs/partners/nomic/
81+
pass_filenames: false
82+
- id: ollama
83+
name: format partners/ollama
84+
language: system
85+
entry: make -C libs/partners/ollama format
86+
files: ^libs/partners/ollama/
87+
pass_filenames: false
88+
- id: openai
89+
name: format partners/openai
90+
language: system
91+
entry: make -C libs/partners/openai format
92+
files: ^libs/partners/openai/
93+
pass_filenames: false
94+
- id: prompty
95+
name: format partners/prompty
96+
language: system
97+
entry: make -C libs/partners/prompty format
98+
files: ^libs/partners/prompty/
99+
pass_filenames: false
100+
- id: qdrant
101+
name: format partners/qdrant
102+
language: system
103+
entry: make -C libs/partners/qdrant format
104+
files: ^libs/partners/qdrant/
105+
pass_filenames: false
106+
- id: root
107+
name: format docs, cookbook
108+
language: system
109+
entry: make format
110+
files: ^(docs|cookbook)/
111+
pass_filenames: false

.readthedocs.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ build:
1313

1414
# Build documentation in the docs/ directory with Sphinx
1515
sphinx:
16-
configuration: docs/api_reference/conf.py
16+
configuration: docs/api_reference/conf.py
1717

1818
# If using Sphinx, optionally build your docs in additional formats such as PDF
1919
formats:
2020
- pdf
2121

2222
# Optionally declare the Python requirements required to build your docs
2323
python:
24-
install:
25-
- requirements: docs/api_reference/requirements.txt
24+
install:
25+
- requirements: docs/api_reference/requirements.txt

MIGRATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ Please see the following guides for migrating LangChain code:
77
* Migrating from [LangChain 0.0.x Chains](https://python.langchain.com/docs/versions/migrating_chains/)
88
* Upgrade to [LangGraph Memory](https://python.langchain.com/docs/versions/migrating_memory/)
99

10-
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.
10+
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.
1111
This will be especially helpful if you're still on either version 0.0.x or 0.1.x of LangChain.

0 commit comments

Comments
 (0)