Conversation
…ty_hosting_manager, output_logging_middleware, and utils docstrings Agent-Logs-Url: https://github.com/microsoft/Agent365-python/sessions/d6bb5f58-003d-4e19-bdb2-66284d1768a6 Co-authored-by: JimDaly <6353736+JimDaly@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix broken DocFx cross-reference links in various docstrings
Fix broken DocFx cross-reference links in span_processor, observability_hosting_manager, output_logging_middleware, and utils
Apr 24, 2026
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
JimDaly
approved these changes
Apr 24, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Python docstrings in the observability core/hosting/extension packages to use fully-qualified Sphinx RST cross-references so DocFx can resolve them instead of emitting unresolved <xref> placeholders.
Changes:
- Replace short
:class:,:meth:, and:data:references with fully-qualified module paths in four modules. - Preserve behavior (docstring-only changes); no runtime logic modifications.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| libraries/microsoft-agents-a365-observability-hosting/microsoft_agents_a365/observability/hosting/middleware/output_logging_middleware.py | Fully-qualifies OutputScope and A365_PARENT_TRACEPARENT_KEY docstring xrefs for DocFx resolution. |
| libraries/microsoft-agents-a365-observability-hosting/microsoft_agents_a365/observability/hosting/middleware/observability_hosting_manager.py | Fully-qualifies configure and ObservabilityHostingManager docstring xrefs. |
| libraries/microsoft-agents-a365-observability-extensions-agentframework/microsoft_agents_a365/observability/extensions/agentframework/span_processor.py | Fully-qualifies EnrichedReadableSpan docstring xref. |
| libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/utils.py | Fully-qualifies OpenTelemetryScope.inject_context_to_headers docstring xref. |
ajmfehr
previously approved these changes
Apr 28, 2026
sellakumaran
previously approved these changes
Apr 29, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Short RST cross-references (e.g.
:class:\EnrichedReadableSpan`) generate unresolvable` placeholders in DocFx-generated API docs because the target isn't defined in the same module.Changes
Replace all short
:class:,:meth:, and:data:cross-references with fully-qualified module paths across four files:agentframework/span_processor.py:class:\EnrichedReadableSpan``observability_hosting_manager.py:meth:\configure`,:class:`ObservabilityHostingManager``output_logging_middleware.py:class:\OutputScope`,:data:`A365_PARENT_TRACEPARENT_KEY``utils.py:meth:\OpenTelemetryScope.inject_context_to_headers``Before:
After:
Docstring-only changes; no logic modified.