docs: correct ported over directives (#33121)

Match rest of repo
This commit is contained in:
Mason Daugherty
2025-09-25 15:54:54 -04:00
committed by GitHub
parent 6d418ba983
commit c3fed20940
4 changed files with 17 additions and 22 deletions

View File

@@ -118,18 +118,13 @@ def example_function(param1: str, param2: int = 5) -> bool:
.. warning::
This function is experimental and may change.
.. deprecated:: 0.2.0
Use :func:`new_function` instead.
"""
```
**Special Markers:**
- `:private:` in docstrings excludes members from documentation
- `.. deprecated::` creates deprecation notices
- `.. warning::` adds warning admonitions
- `.. beta::` (custom directive) marks beta features
#### Site Styling and Assets

View File

@@ -971,7 +971,7 @@ def create_agent( # noqa: D417
return model.bind_tools(tools)
```
!!! note "Dynamic Model Requirements"
.. note::
Ensure returned models have appropriate tools bound via
`.bind_tools()` and support required functionality. Bound tools
must be a subset of those specified in the `tools` parameter.
@@ -1011,10 +1011,10 @@ def create_agent( # noqa: D417
- description: Optional custom description (defaults to model docstring)
- strict: Whether to enforce strict validation
!!! Important
.. important::
`response_format` requires the model to support tool calling
!!! Note
.. note::
Structured responses are handled directly in the model call node via tool calls,
eliminating the need for separate structured response nodes.
@@ -1037,12 +1037,12 @@ def create_agent( # noqa: D417
}
```
!!! Important
.. important::
At least one of `messages` or `llm_input_messages` MUST be provided
and will be used as an input to the `agent` node.
The rest of the keys will be added to the graph state.
!!! Warning
.. warning::
If you are returning `messages` in the pre-model hook,
you should OVERWRITE the `messages` key by doing the following:
@@ -1059,7 +1059,7 @@ def create_agent( # noqa: D417
Post-model hook must be a callable or a runnable that takes in
current graph state and returns a state update.
!!! Note
.. note::
Only available with `version="v2"`.
state_schema: An optional state schema that defines graph state.
Must have `messages` and `remaining_steps` keys.
@@ -1092,7 +1092,7 @@ def create_agent( # noqa: D417
another graph as a subgraph node -
particularly useful for building multi-agent systems.
!!! warning "`config_schema` Deprecated"
.. warning::
The `config_schema` parameter is deprecated in v0.6.0 and support will be removed in v2.0.0.
Please use `context_schema` instead to specify the schema for run-scoped context.

View File

@@ -1020,7 +1020,7 @@ class InjectedStore(InjectedToolArg):
for maintaining context, user preferences, or any other data that needs to
persist beyond individual workflow executions.
!!! Warning
.. warning::
`InjectedStore` annotation requires `langchain-core >= 0.3.8`
Example:

18
uv.lock generated
View File

@@ -2218,7 +2218,7 @@ dev = [
lint = [
{ name = "cffi", marker = "python_full_version < '3.10'", specifier = "<1.17.1" },
{ name = "cffi", marker = "python_full_version >= '3.10'" },
{ name = "ruff", specifier = ">=0.12.2,<0.13.0" },
{ name = "ruff", specifier = ">=0.13.1,<0.14.0" },
]
test = [
{ name = "blockbuster", specifier = ">=1.5.18,<1.6.0" },
@@ -2292,7 +2292,7 @@ requires-dist = [
[package.metadata.requires-dev]
dev = [{ name = "langchain-core", editable = "libs/core" }]
lint = [{ name = "ruff", specifier = ">=0.12.9,<0.13.0" }]
lint = [{ name = "ruff", specifier = ">=0.13.1,<0.14.0" }]
test = [
{ name = "defusedxml", specifier = ">=0.7.1,<1.0.0" },
{ name = "freezegun", specifier = ">=1.2.2,<2.0.0" },
@@ -2354,7 +2354,7 @@ dev = [{ name = "langchain-core", editable = "libs/core" }]
lint = [
{ name = "onnxruntime", marker = "python_full_version < '3.10'", specifier = "<1.20" },
{ name = "onnxruntime", marker = "python_full_version >= '3.10'" },
{ name = "ruff", specifier = ">=0.12.2,<0.13.0" },
{ name = "ruff", specifier = ">=0.13.1,<0.14.0" },
]
test = [
{ name = "freezegun", specifier = ">=1.2.2,<2.0.0" },
@@ -2432,7 +2432,7 @@ dev = [
{ name = "jupyter", specifier = ">=1.0.0,<2.0.0" },
{ name = "setuptools", specifier = ">=67.6.1,<68.0.0" },
]
lint = [{ name = "ruff", specifier = ">=0.12.2,<0.13.0" }]
lint = [{ name = "ruff", specifier = ">=0.13.1,<0.14.0" }]
test = [
{ name = "blockbuster", specifier = ">=1.5.18,<1.6.0" },
{ name = "freezegun", specifier = ">=1.2.2,<2.0.0" },
@@ -2491,7 +2491,7 @@ requires-dist = [
[package.metadata.requires-dev]
dev = [{ name = "langchain-core", editable = "libs/core" }]
lint = [{ name = "ruff", specifier = ">=0.12.2,<0.13.0" }]
lint = [{ name = "ruff", specifier = ">=0.13.1,<0.14.0" }]
test = [
{ name = "freezegun", specifier = ">=1.2.2,<2.0.0" },
{ name = "langchain-core", editable = "libs/core" },
@@ -2552,7 +2552,7 @@ requires-dist = [
[package.metadata.requires-dev]
dev = [{ name = "langchain-core", editable = "libs/core" }]
lint = [{ name = "ruff", specifier = ">=0.12.2,<0.13.0" }]
lint = [{ name = "ruff", specifier = ">=0.13.1,<0.14.0" }]
test = [
{ name = "langchain-core", editable = "libs/core" },
{ name = "langchain-tests", editable = "libs/standard-tests" },
@@ -2591,7 +2591,7 @@ requires-dist = [
[package.metadata.requires-dev]
dev = [{ name = "langchain-core", editable = "libs/core" }]
lint = [{ name = "ruff", specifier = ">=0.12.2,<0.13.0" }]
lint = [{ name = "ruff", specifier = ">=0.13.1,<0.14.0" }]
test = [
{ name = "langchain-core", editable = "libs/core" },
{ name = "langchain-tests", editable = "libs/standard-tests" },
@@ -2750,7 +2750,7 @@ requires-dist = [
[package.metadata.requires-dev]
dev = [{ name = "langchain-core", editable = "libs/core" }]
lint = [{ name = "ruff", specifier = ">=0.12.8,<0.13.0" }]
lint = [{ name = "ruff", specifier = ">=0.13.1,<0.14.0" }]
test = [
{ name = "freezegun", specifier = ">=1.2.2,<2.0.0" },
{ name = "langchain-core", editable = "libs/core" },
@@ -2814,7 +2814,7 @@ dev = [
]
lint = [
{ name = "langchain-core", editable = "libs/core" },
{ name = "ruff", specifier = ">=0.12.8,<0.13.0" },
{ name = "ruff", specifier = ">=0.13.1,<0.14.0" },
]
test = [
{ name = "freezegun", specifier = ">=1.2.2,<2.0.0" },