Skip to content

Fix broken cross-reference links in message_mapper.py docstrings #241

Description

@JimDaly

The DocFx-generated API page for message_mapper shows unresolved xref placeholders instead of links:

<xref:InputMessages>
<xref:OutputMessages>

Root cause: The docstrings in libraries/microsoft-agents-a365-observability-extensions-agentframework/microsoft_agents_a365/observability/extensions/agentframework/message_mapper.py use short :class: references (e.g., :class:InputMessages``). DocFx converts these to <xref:InputMessages>, which it cannot resolve because `InputMessages` is not defined in this module — it is imported from `microsoft_agents_a365.observability.core.models.messages`.

Fix required: Replace the short :class: references with fully-qualified names so DocFx can resolve them to their definition site. No logic changes are needed — this is a docstring-only fix.

Line Current Replace with
8 (module docstring) :class:InputMessages`` :class:microsoft_agents_a365.observability.core.models.messages.InputMessages``
8 (module docstring) :class:OutputMessages`` :class:microsoft_agents_a365.observability.core.models.messages.OutputMessages``
53 (map_input_messages Returns) :class:InputMessages`` :class:microsoft_agents_a365.observability.core.models.messages.InputMessages``
87 (map_output_messages Returns) :class:OutputMessages`` :class:microsoft_agents_a365.observability.core.models.messages.OutputMessages``
122 (_map_role docstring) :class:MessageRole`` :class:microsoft_agents_a365.observability.core.models.messages.MessageRole``

Activity

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions