Commit 48e738a
committed
docs(thread): fully qualify Sphinx Chat refs (gemini review)
Rewrites `:py:meth:`Chat.on_subscribed_message`` and
`:py:meth:`Chat.on_direct_message`` in `Thread.subscribe`'s docstring as
`:py:meth:`~chat_sdk.chat.Chat.on_subscribed_message`` and
`:py:meth:`~chat_sdk.chat.Chat.on_direct_message``.
`Chat` is intentionally not imported in `thread.py` (TYPE_CHECKING-only) to
avoid a circular import. The unqualified refs wouldn't resolve under Sphinx;
the absolute paths do, and the `~` keeps the rendered link text short.
The `test_thread_subscribe_docstring_documents_dm_carveout` pin still passes:
its `"on_direct_message" in doc` assertion matches the substring inside the
new qualified ref.
https://claude.ai/code/session_01FyMxQn2BEAzmwKS1GZczKj1 parent 183ca4f commit 48e738a
1 file changed
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
507 | 507 | | |
508 | 508 | | |
509 | 509 | | |
510 | | - | |
511 | | - | |
| 510 | + | |
| 511 | + | |
512 | 512 | | |
513 | 513 | | |
514 | 514 | | |
| |||
0 commit comments