Fix broken links in documentation to microsoft_agents_a365.notifications.models.agent_notification_activity.TModel
評価
この issue はまだ評価されていません。
説明
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.
- 主要言語
- Python
- スター
- 41
- フォーク
- 23
- 平均マージ
- 7時間 43分
- マージ済み PR(30日)
- 3
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
microsoft/Agent365-python のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
microsoft/Agent365-python#249 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 78/100
microsoft/Agent365-python#271 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
microsoft/Agent365-python#270 ·
-
[python/agent-framework/sample-agent] Sample dependencies are inconsistent on PyPI — cannot run オープン
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
microsoft/Agent365-python#262 ·
-
microsoft/Agent365-python#257 · コメント 2 件 · 担当者 1 名 ·
microsoft/Agent365-python の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
zostera/django-bootstrap4#894 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
use-agent-os/agent-os#3276 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
NousResearch/hermes-agent#117848 ·