Skip to content

Fix broken cross-reference links and raw GitHub URLs in CustomLangChainTracer docstrings#246

Merged
JimDaly merged 4 commits intomainfrom
copilot/fix-cross-reference-links
Apr 29, 2026
Merged

Fix broken cross-reference links and raw GitHub URLs in CustomLangChainTracer docstrings#246
JimDaly merged 4 commits intomainfrom
copilot/fix-cross-reference-links

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 24, 2026

DocFx-generated API docs for CustomLangChainTracer produced unresolved cross-reference warnings and rendered raw GitHub source URLs as confusing literal links.

Changes

  • __init__ docstring — Remove Google-style parenthesised type annotations (tracer (trace_api.Tracer):, *args (Any):, etc.) that DocFx was extracting as unresolvable <xref:…> cross-references. Types are already on the signature. Also corrects the stale title ("OpenInferenceTracer""CustomLangChainTracer").
# Before
Args:
    tracer (trace_api.Tracer): The OpenTelemetry tracer for creating spans.
    *args (Any): Positional arguments for BaseTracer.

# After
Args:
    tracer: The OpenTelemetry tracer for creating spans.
    *args: Positional arguments forwarded to BaseTracer.
  • on_chat_model_start docstring — Replace three raw https://github.com/langchain-ai/langchain/blob/… URLs (which rendered as implementation-internal hyperlinks in published docs) with a concise plain-text explanation of why the method delegates to LangChainTracer. Removes the now-unnecessary # noqa: E501.

Copilot AI changed the title [WIP] Fix broken cross-reference links and raw GitHub URLs in CustomLangChainTracer docstrings Fix broken cross-reference links and raw GitHub URLs in CustomLangChainTracer docstrings Apr 24, 2026
Copilot AI requested a review from JimDaly April 24, 2026 21:16
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 24, 2026

⚠️ Deprecation Warning: The deny-licenses option is deprecated for possible removal in the next major release. For more information, see issue 997.

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@JimDaly JimDaly marked this pull request as ready for review April 24, 2026 22:31
@JimDaly JimDaly requested a review from a team as a code owner April 24, 2026 22:31
Copilot AI review requested due to automatic review settings April 24, 2026 22:31
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates CustomLangChainTracer docstrings to improve DocFx-generated API documentation by eliminating unresolved cross-references and removing confusing raw GitHub source links.

Changes:

  • Adjusted __init__ docstring to remove parenthesized type annotations in the Args: section and corrected the initializer title to CustomLangChainTracer.
  • Rewrote on_chat_model_start docstring to replace raw GitHub URLs with a concise explanation and removed the now-unneeded # noqa: E501.

@JimDaly JimDaly enabled auto-merge (squash) April 29, 2026 17:20
Copilot AI review requested due to automatic review settings April 29, 2026 20:16
@JimDaly JimDaly merged commit 1fb4953 into main Apr 29, 2026
12 checks passed
@JimDaly JimDaly deleted the copilot/fix-cross-reference-links branch April 29, 2026 20:19
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix broken cross-reference links and raw GitHub URLs in CustomLangChainTracer docstrings

5 participants