microsoft / microsoft/Agent365-python

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

Offen
#239 0 Kommentare 1 Reaktion 2 zugewiesene Personen Auf GitHub ansehen

@JimDaly arbeitet bereits daran.

Seit 24.4.2026.

  • #240 von @copilot-swe-agent — ohne Merge geschlossen
Vorherrschende Sprache
Python
Sterne
41
Forks
23
Ø Merge
7 Std. 43 Min.
Gemergte PRs (30 T.)
3

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.