Repository navigation
Commit 21c2b72
committed
Use the :exc: Sphinx role for DeprecationWarning
Python warnings are exceptions, to facilitate converting them to
errors by raising them. Thus the more specific :exc: role applies
and is a better fit than the more general :class: role.1 parent 9d096e0 commit 21c2b72
1 file changed
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1285,7 +1285,7 @@ def list_items(cls, repo: "Repo", *args: Any, **kwargs: Any) -> IterableList[T_I | |||
| 1285 | 1285 | ||
| 1286 | 1286 | ||
| 1287 | 1287 | class IterableClassWatcher(type): | |
| 1288 | - """Metaclass that issues :class:`DeprecationWarning` when :class:`git.util.Iterable` | ||
| 1288 | + """Metaclass that issues :exc:`DeprecationWarning` when :class:`git.util.Iterable` | ||
| 1289 | 1289 | is subclassed.""" | |
| 1290 | 1290 | ||
| 1291 | 1291 | def __init__(cls, name: str, bases: Tuple, clsdict: Dict) -> None: | |
0 commit comments