microsoft / microsoft/Agent365-python

Fix broken links in documentation to microsoft_agents_a365.notifications.models.agent_notification_activity.TModel

Abierto
#239 0 comentarios 1 reacción 2 asignados Ver en GitHub

@JimDaly ya está trabajando en esto.

Desde el 24/4/2026.

  • #240 de @copilot-swe-agent — cerrado sin fusionar
Lenguaje dominante
Python
Estrellas
41
Forks
23
Merge medio
7 h 43 min
PR fusionados (30 d)
3

Descripción

The documentation for the AgentNotificationActivity.as_model method contains broken links to <xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>

Cause according to Claude:

The DocFx generator sees the TypeVar in the type annotation and tries to build a cross-reference link to it — just like it would for a real class. But TModel is a TypeVar, not a documented type, so there's no page to link to and the xref renders as broken text:

Type[<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>]

TypeVar is defined at module level (agent_notification_activity.py:10):

TModel = TypeVar("TModel")

DocFx doesn't have special handling for TypeVar instances — it treats them like class references. This is a doc generator limitation, but the underlying cause is that TypeVar at module scope bleeds into the doc generation as if it were a public documented type.

Claude's recommendation to fix:

Rename TModel to _TModel (underscore prefix) at [agent_notification_activity.py:10].

The underscore convention marks it as private/internal. Doc generators respect this and won't try to generate a cross-reference link for it — they'll render it as plain text instead.

before

TModel = TypeVar("TModel")

def as_model(self, model: Type[TModel]) -> Optional[TModel]:

after

_TModel = TypeVar("_TModel")

def as_model(self, model: Type[_TModel]) -> Optional[_TModel]:

This is also the standard Python convention — TypeVars that aren't part of a public generic API (e.g., on a public generic class) should always be underscore-prefixed.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.