Fix broken links in documentation to microsoft_agents_a365.notifications.models.agent_notification_activity.TModel
@JimDaly já está trabalhando nisso.
Desde 24/4/2026.
- #240 de @copilot-swe-agent — fechado sem integrar
Avaliação
Esta issue ainda não foi avaliada.
Descrição
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.
- Linguagem predominante
- Python
- Estrelas
- 41
- Forks
- 23
- Merge médio
- 19h 58min
- PRs com merge (30d)
- 2
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de microsoft/Agent365-python
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
microsoft/Agent365-python#249 ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 78/100
microsoft/Agent365-python#271 ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 68/100
microsoft/Agent365-python#270 ·
-
[python/agent-framework/sample-agent] Sample dependencies are inconsistent on PyPI — cannot runAberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 38/100
microsoft/Agent365-python#262 ·
-
Bug: NonRecordingSpan crashes with 'NonRecordingSpan object has no attribute context' when observability exporter is enabledTalvez livre de novo @nikhilNava assumiu há 131 dias e não há nenhum pull request aberto. Aberta
microsoft/Agent365-python#257 · 2 comentários · 1 responsável ·
Todas as issues de microsoft/Agent365-python
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Mantenedores costumam responder em até 3 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
modelcontextprotocol/python-sdk#3648 ·
Mantenedores costumam responder em até 1 dia
-
docs good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
VenetoStato/giorgio#6 ·
-
Claiming namespace ddalusAberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 70/100
EclipseFdn/open-vsx.org#13831 ·
Mantenedores costumam responder em até 1 dia
-
feature request
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Mantenedores costumam responder em até 2 dias