Fix unresolved xref placeholders in message_mapper.py DocFx output#242
Merged
Fix unresolved xref placeholders in message_mapper.py DocFx output#242
Conversation
Agent-Logs-Url: https://github.com/microsoft/Agent365-python/sessions/87826ea9-9bc3-47b2-9b3b-b03fb3f647c6 Co-authored-by: JimDaly <6353736+JimDaly@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix broken cross-reference links in message_mapper.py docstrings
Fix unresolved xref placeholders in message_mapper.py DocFx output
Apr 24, 2026
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes DocFx API doc generation by avoiding short RST :class: roles that DocFx renders as unresolved <xref:...> placeholders in generated documentation.
Changes:
- Replace
:class:references with double-backtick inline code in Agent Frameworkmessage_mapper.pydocstrings (module + function docs + helper doc). - Apply the same docstring formatting fix to OpenAI
message_mapper.pyreturn-value docs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| libraries/microsoft-agents-a365-observability-extensions-agentframework/microsoft_agents_a365/observability/extensions/agentframework/message_mapper.py | Switches :class: references to inline code to prevent unresolved xref placeholders in DocFx output. |
| libraries/microsoft-agents-a365-observability-extensions-openai/microsoft_agents_a365/observability/extensions/openai/message_mapper.py | Updates return docstrings to use inline code formatting for message wrapper types, preventing DocFx xref placeholders. |
JimDaly
approved these changes
Apr 28, 2026
ajmfehr
approved these changes
Apr 28, 2026
sellakumaran
approved these changes
Apr 29, 2026
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
:class:roles (e.g.:class:InputMessages``) cause DocFx to emit unresolvable<xref:InputMessages>placeholders in generated API docs instead of rendered links.Changes
agentframework/message_mapper.py— Replace all four:class:`` occurrences (module docstring,map_input_messages,map_output_messages,_map_role`) with plain double-backtick code formattingopenai/message_mapper.py— Same fix formap_input_messagesandmap_output_messagesreturn-value docsBefore / After