Repository navigation
Commit 679d2e8
committed
Fix exception type in require_remote_ref_path docstring
The require_remote_ref_path decorator has always used ValueError
(ever since its introduction in a92ab80) but was documented as
using TypeError.
ValueError is the correct exception to raise here, since this is
not any kind of type error or related condition. So the bug wasn't
in the function's behavior, but instead in the way that behavior
was documented. (The bug was fairly minor, since the function is
not listed in __all__.)1 parent 254c82a commit 679d2e8
1 file changed
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -25,7 +25,7 @@ | |||
| 25 | 25 | ||
| 26 | 26 | ||
| 27 | 27 | def require_remote_ref_path(func: Callable[..., _T]) -> Callable[..., _T]: | |
| 28 | - """A decorator raising :class:`TypeError` if we are not a valid remote, based on the | ||
| 28 | + """A decorator raising :class:`ValueError` if we are not a valid remote, based on the | ||
| 29 | 29 | path.""" | |
| 30 | 30 | ||
| 31 | 31 | def wrapper(self: T_References, *args: Any) -> _T: | |
0 commit comments