mirror of
https://github.com/langchain-ai/langgraph.git
synced 2026-09-12 20:57:52 +02:00
ci(docs): Add codespell for docs md and py files (#5494)
* docs: Add codespell for markdown files * update * remove path * fix * update linting guidelines * chore[deps]: upgrade dependencies with `uv lock --upgrade` (#5471) Co-authored-by: sydney-runkle <54324534+sydney-runkle@users.noreply.github.com> * fix(checkpoint): correct logging call to use logger (#5458) fix[checkpoint]: correct logging call to use logger * release(langgraph): v0.5.3 (#5498) bump * extend to cover python files used for reference docs * fix(docs): Update the graph image link (#5500) Update the graph image link Point to the correct image reference for Map-Reduce and the Send API example * fix(docs): Update graph-api.md File to reflect correct image (#5499) Update graph-api.md File to reflect correct image Referencing to the correct image file * docs(prebuilt): improve documentation in ToolNode module (#5497) Update documentation in ToolNode module * Update changelog via LangGraph Server Changelog Bot * feat(sdk-py): Show is_studio_user (#5505) * Update changelog via LangGraph Server Changelog Bot * fix(docs): Node caching explanation code required a small fix,. (#5473) fix(docs): Node caching explanation code required a small fix, to avoid confusion to readers. The code had `time.sleep(2)` but the note mentioned one second only. Co-authored-by: ygicp <yagnesh@infocusp.com> * fix(langgraph): add `stacklevel=2` to the warnings to point to the caller’s codes (#5457) chore: add stacklevel=2 to the warnings to point to the caller’s codes * chore(docs): Improve example in use mcp (#5480) * Make example more explicit * Update docs/docs/agents/mcp.md * fix(docs): update examples link (#5515) Co-authored-by: ahmed murtaza <ahmed.gmurtaza@gmail.com> * docs: [LangGraph Server Changelog Bot] Changelog updates for new version(s) (#5514) Update changelog via LangGraph Server Changelog Bot * fix readmes * fix --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: sydney-runkle <54324534+sydney-runkle@users.noreply.github.com> Co-authored-by: Michael Li <michaelli65535@gmail.com> Co-authored-by: Sakshi Gupta <64280320+sakshi1989@users.noreply.github.com> Co-authored-by: Eugene Yurtsev <eyurtsev@gmail.com> Co-authored-by: Sam Crowder <samecrowder@gmail.com> Co-authored-by: William FH <13333726+hinthornw@users.noreply.github.com> Co-authored-by: Yagnesh M. Bhadiyadra <35532869+yagneshmb@users.noreply.github.com> Co-authored-by: ygicp <yagnesh@infocusp.com> Co-authored-by: Ahmed Murtaza <ahmed.gmurtaza@hotmail.com> Co-authored-by: ahmed murtaza <ahmed.gmurtaza@gmail.com>
This commit is contained in:
co-authored by
sydney-runkle
ygicp
ahmed murtaza
github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Michael Li
Sakshi Gupta
Eugene Yurtsev
Sam Crowder
William FH
Yagnesh M. Bhadiyadra
Ahmed Murtaza
parent
40c0e44b9a
commit
d5b8733a40
@@ -0,0 +1,11 @@
|
||||
LangChain
|
||||
LangGraph
|
||||
LangSmith
|
||||
thead
|
||||
stdio
|
||||
nd
|
||||
jupyter
|
||||
lets
|
||||
lite
|
||||
uis
|
||||
deque
|
||||
@@ -34,10 +34,16 @@
|
||||
id: extract_ignore_words
|
||||
|
||||
- name: Codespell
|
||||
uses: codespell-project/actions-codespell@v2
|
||||
uses: codespell-project/actions-codespell@v2.0
|
||||
with:
|
||||
skip: '*.ambr,*.lock,*.ipynb,*.yaml,*.zlib,*.md'
|
||||
skip: '*.ambr,*.lock,*.ipynb,*.yaml,*.zlib,*.css.map,*.js.map'
|
||||
ignore_words_list: ${{ steps.extract_ignore_words.outputs.ignore_words_list }}
|
||||
# We do this to avoid spellchecking cell outputs
|
||||
- name: Codespell Notebooks
|
||||
run: make codespell
|
||||
run: make codespell
|
||||
|
||||
- name: Codespell LangGraph Library
|
||||
run: |
|
||||
# Change to root directory to check the main LangGraph library
|
||||
cd ..
|
||||
codespell --skip="*.ambr,*.lock,*.ipynb,*.yaml,*.zlib,*.css.map,*.js.map,*.pyc,__pycache__/*" --ignore-words-list="${{ steps.extract_ignore_words.outputs.ignore_words_list }}" libs/langgraph/langgraph/
|
||||
+2
-2
@@ -249,10 +249,10 @@ make serve-docs
|
||||
|
||||
#### Linting
|
||||
|
||||
The documentation is linted from the **monorepo root**. To lint it, run the following from there:
|
||||
To spell check the docs, run the following from the `docs` directory:
|
||||
|
||||
```bash
|
||||
make spellcheck
|
||||
codespell --skip="*.ambr,*.lock,*.ipynb,*.yaml,*.zlib,*.css.map,*.js.map" --ignore-words-list="infor,thead,stdio,nd,jupyter,lets,lite,uis,deque" .
|
||||
```
|
||||
|
||||
### ️In-code Documentation
|
||||
|
||||
@@ -81,4 +81,4 @@ While LangGraph can be used standalone, it also integrates seamlessly with any L
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
LangGraph is inspired by [Pregel](https://research.google/pubs/pub37252/) and [Apache Beam](https://beam.apache.org/). The public interface draws inspiration from [NetworkX](https://networkx.org/documentation/latest/). LangGraph is built by LangChain Inc, the creators of LangChain, but can be used without LangChain.
|
||||
LangGraph is inspired by [Pregel](https://research.google/pubs/pub37252/) and [Apache Beam](https://beam.apache.org/). The public interface draws inspiration from [NetworkX](https://networkx.org/documentation/latest/). LangGraph is built by LangChain Inc, the creators of LangChain, but can be used without LangChain.
|
||||
+3
-1
@@ -112,4 +112,6 @@ extend-include = ["*.ipynb"]
|
||||
[tool.codespell]
|
||||
# https://mypy.readthedocs.io/en/stable/config_file.html
|
||||
# comma-separated list
|
||||
ignore-words-list = "infor"
|
||||
ignore-words-list = "infor,thead,stdio,nd,jupyter,lets,lite,uis,deque"
|
||||
# Exclude generated files and directories
|
||||
skip = "*.ambr,*.lock,*.ipynb,*.yaml,*.zlib,*.css.map,*.js.map"
|
||||
|
||||
@@ -81,4 +81,4 @@ While LangGraph can be used standalone, it also integrates seamlessly with any L
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
LangGraph is inspired by [Pregel](https://research.google/pubs/pub37252/) and [Apache Beam](https://beam.apache.org/). The public interface draws inspiration from [NetworkX](https://networkx.org/documentation/latest/). LangGraph is built by LangChain Inc, the creators of LangChain, but can be used without LangChain.
|
||||
LangGraph is inspired by [Pregel](https://research.google/pubs/pub37252/) and [Apache Beam](https://beam.apache.org/). The public interface draws inspiration from [NetworkX](https://networkx.org/documentation/latest/). LangGraph is built by LangChain Inc, the creators of LangChain, but can be used without LangChain.
|
||||
@@ -106,3 +106,7 @@ packages = ["langgraph"]
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
addopts = "--full-trace --strict-markers --strict-config --durations=5 --snapshot-warn-unused"
|
||||
|
||||
[tool.codespell]
|
||||
# Ignore words specific to the LangGraph library code
|
||||
ignore-words-list = "infor,thead,stdio,nd,jupyter,lets,lite,uis,deque,langgraph,langchain,pydantic,typing,async,await,coroutine,iterable,iterables,serializable,deserializable,checkpointer,checkpointing,stateful,statefulness,prebuilt,prebuilt,supervisor,supervisory,swarm,swarming,multiactor,multiactors,subgraph,subgraphs,workflow,workflows,streaming,streamable,streamed,streamer,streamers,streaming,streamable,streamed,streamer,streamers"
|
||||
|
||||
Reference in New Issue
Block a user