Fix broken links in documentation to microsoft_agents_a365.notifications.models.agent_notification_activity.TModel
@JimDaly arbeitet bereits daran.
Seit 24.4.2026.
- #240 von @copilot-swe-agent — ohne Merge geschlossen
Bewertung
Dieses Issue wurde noch nicht bewertet.
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.
- Vorherrschende Sprache
- Python
- Sterne
- 41
- Forks
- 23
- Ø Merge
- 21 Std. 24 Min.
- Gemergte PRs (30 T.)
- 1
Entwicklungsumgebung
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus microsoft/Agent365-python
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
microsoft/Agent365-python#249 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 78/100
microsoft/Agent365-python#271 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
microsoft/Agent365-python#270 ·
-
[python/agent-framework/sample-agent] Sample dependencies are inconsistent on PyPI — cannot runOffen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 38/100
microsoft/Agent365-python#262 ·
-
Bug: NonRecordingSpan crashes with 'NonRecordingSpan object has no attribute context' when observability exporter is enabledEvtl. wieder frei @nikhilNava hat das vor 127 Tagen übernommen, und es ist kein Pull Request offen. Offen
microsoft/Agent365-python#257 · 2 Kommentare · 1 zugewiesene Person ·
Alle Issues in microsoft/Agent365-python
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
BasedHardware/omi#20271 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 92/100
openai/openai-cookbook#3153 ·
Maintainer antworten meist innerhalb von 1 Tag
-
cvss-severity:high devguard l3montree-cybersecurity/devguard/devguard pkg:golang/github.com/l3montree-dev/devguard risk:low state:open
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
l3montree-dev/devguard#3146 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
-
bug confirmed issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
open-webui/open-webui#31849 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag