langchain-ai/docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/docs.git synced 2026-07-23 04:45:23 -04:00
Code Issues 490 Packages Projects Releases Wiki Activity

[PR #3099] [MERGED] fix(oss): remove redundant ellipsis from Field() examples #3175

New Issue
Closed
opened 2026-06-05 18:21:19 -04:00 by yindo · 0 comments
yindo commented 2026-06-05 18:21:19 -04:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/3099
Author: @pawel-twardziak
Created: 3/13/2026
Status: ✅ Merged
Merged: 3/13/2026
Merged by: @mdrxy

Base: main ← Head: fix/structured-output-field-ellipsis

📝 Commits (5)

  • 3da535a fix(oss): remove redundant ellipsis from Field() examples
  • 535f4b3 fix: remove uneeded note
  • 3a92340 undo
  • 47c44b8 consistency
  • 1a048e8 Merge branch 'main' into fix/structured-output-field-ellipsis

📊 Changes

18 files changed (+49 additions, -49 deletions)

View changed files

📝 src/oss/langchain/models.mdx (+10 -10)
📝 src/oss/python/integrations/chat/amazon_nova.mdx (+1 -1)
📝 src/oss/python/integrations/chat/anthropic.mdx (+6 -6)
📝 src/oss/python/integrations/chat/databricks.mdx (+2 -2)
📝 src/oss/python/integrations/chat/edenai.mdx (+1 -1)
📝 src/oss/python/integrations/chat/ibm_watsonx.mdx (+1 -1)
📝 src/oss/python/integrations/chat/nvidia_ai_endpoints.mdx (+1 -1)
📝 src/oss/python/integrations/chat/openai.mdx (+5 -5)
📝 src/oss/python/integrations/chat/openrouter.mdx (+5 -5)
📝 src/oss/python/integrations/chat/predictionguard.mdx (+2 -2)
📝 src/oss/python/integrations/chat/premai.mdx (+4 -4)
📝 src/oss/python/integrations/chat/writer.mdx (+1 -1)
📝 src/oss/python/integrations/chat/xai.mdx (+1 -1)
📝 src/oss/python/integrations/chat_loaders/langsmith_llm_runs.mdx (+1 -1)
📝 src/oss/python/integrations/providers/premai.mdx (+4 -4)
📝 src/oss/python/integrations/retrievers/activeloop.mdx (+1 -1)
📝 src/oss/python/integrations/tools/composio.mdx (+2 -2)
📝 src/oss/python/integrations/tools/writer.mdx (+1 -1)

📄 Description

Remove redundant ... from Field(..., description="...") in models.mdx structured output examples, aligning with Pydantic v2 style already used in structured-output.mdx. Also adds a <Note> in the Pydantic tab explaining required vs optional fields, and an inline sentence in the TypedDict tab explaining the ... sentinel in Annotated syntax.

Type of change

Type: Fix typo/bug/link/formatting

Related issues/PRs

  • GitHub issue:

Fixes #3098

Checklist

  • I have read the contributing guidelines, including the language policy
  • I have tested my changes locally using docs dev
  • All code examples have been tested and work correctly
  • I have used root relative paths for internal links
  • I have updated navigation in src/docs.json if needed

Additional notes

Field(description="...") without ... is equivalent in Pydantic v2 fields with no default remain required. LangChain >= 0.3 requires Pydantic v2, so no backwards-compatibility concern.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/3099 **Author:** [@pawel-twardziak](https://github.com/pawel-twardziak) **Created:** 3/13/2026 **Status:** ✅ Merged **Merged:** 3/13/2026 **Merged by:** [@mdrxy](https://github.com/mdrxy) **Base:** `main` ← **Head:** `fix/structured-output-field-ellipsis` --- ### 📝 Commits (5) - [`3da535a`](https://github.com/langchain-ai/docs/commit/3da535a4828a502dd11b8b7ea909fca697c41e9d) fix(oss): remove redundant ellipsis from Field() examples - [`535f4b3`](https://github.com/langchain-ai/docs/commit/535f4b3602322dc2b72ab5cfbc5637934b2891a2) fix: remove uneeded note - [`3a92340`](https://github.com/langchain-ai/docs/commit/3a92340a59f64fa3390dcfbbbfb01108adcf3eb9) undo - [`47c44b8`](https://github.com/langchain-ai/docs/commit/47c44b80d445ed28967e64752d2077d708eec18c) consistency - [`1a048e8`](https://github.com/langchain-ai/docs/commit/1a048e85b87e892483883187d4efd972e19abfef) Merge branch 'main' into fix/structured-output-field-ellipsis ### 📊 Changes **18 files changed** (+49 additions, -49 deletions) <details> <summary>View changed files</summary> 📝 `src/oss/langchain/models.mdx` (+10 -10) 📝 `src/oss/python/integrations/chat/amazon_nova.mdx` (+1 -1) 📝 `src/oss/python/integrations/chat/anthropic.mdx` (+6 -6) 📝 `src/oss/python/integrations/chat/databricks.mdx` (+2 -2) 📝 `src/oss/python/integrations/chat/edenai.mdx` (+1 -1) 📝 `src/oss/python/integrations/chat/ibm_watsonx.mdx` (+1 -1) 📝 `src/oss/python/integrations/chat/nvidia_ai_endpoints.mdx` (+1 -1) 📝 `src/oss/python/integrations/chat/openai.mdx` (+5 -5) 📝 `src/oss/python/integrations/chat/openrouter.mdx` (+5 -5) 📝 `src/oss/python/integrations/chat/predictionguard.mdx` (+2 -2) 📝 `src/oss/python/integrations/chat/premai.mdx` (+4 -4) 📝 `src/oss/python/integrations/chat/writer.mdx` (+1 -1) 📝 `src/oss/python/integrations/chat/xai.mdx` (+1 -1) 📝 `src/oss/python/integrations/chat_loaders/langsmith_llm_runs.mdx` (+1 -1) 📝 `src/oss/python/integrations/providers/premai.mdx` (+4 -4) 📝 `src/oss/python/integrations/retrievers/activeloop.mdx` (+1 -1) 📝 `src/oss/python/integrations/tools/composio.mdx` (+2 -2) 📝 `src/oss/python/integrations/tools/writer.mdx` (+1 -1) </details> ### 📄 Description Remove redundant `...` from `Field(..., description="...")` in `models.mdx` structured output examples, aligning with Pydantic v2 style already used in `structured-output.mdx`. Also adds a `<Note>` in the Pydantic tab explaining required vs optional fields, and an inline sentence in the TypedDict tab explaining the `...` sentinel in `Annotated` syntax. ## Type of change **Type:** Fix typo/bug/link/formatting ## Related issues/PRs - GitHub issue: Fixes #3098 ## Checklist - [x] I have read the [contributing guidelines](README.md), including the [language policy](https://docs.langchain.com/oss/python/contributing/overview#language-policy) - [x] I have tested my changes locally using `docs dev` - [x] All code examples have been tested and work correctly - [x] I have used **root relative** paths for internal links - [x] I have updated navigation in `src/docs.json` if needed ## Additional notes `Field(description="...")` without `...` is equivalent in Pydantic v2 fields with no default remain required. LangChain >= 0.3 requires Pydantic v2, so no backwards-compatibility concern. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 18:21:19 -04:00
yindo closed this issue 2026-06-05 18:21:20 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
deepagents
docs-infra
external
external
help wanted
integration
internal
internal
javascript
js/ts
langchain
langgraph
langsmith
needs-title
pull-request
Mirrored from GitHub Pull Request
 python
reference
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#3175
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?