Skip to content

Commit 84b9f8d

Browse files
committed
CHANGES(docs[deprecations]): Use Sphinx autodoc links for exceptions
why: Provide clickable documentation links for exception types. what: - Use {exc} role for DeprecatedError - Use {class} role for DeprecationWarning
1 parent a9487a6 commit 84b9f8d

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CHANGES

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ _Upcoming changes will be written here._
4646

4747
#### APIs deprecated (#611)
4848

49-
Legacy API methods now raise `libtmux.exc.DeprecatedError` (hard error) instead of emitting `DeprecationWarning`.
49+
Legacy API methods now raise {exc}`~libtmux.exc.DeprecatedError` (hard error) instead of emitting {class}`DeprecationWarning`.
5050

5151
See {doc}`migration` for full context and examples.
5252

0 commit comments

Comments
 (0)