Fix exception type in require_remote_ref_path docstring

EliahKagan · EliahKagan · commit 679d2e87b4a4 · 2024-02-28T22:04:57.000-05:00
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__.)
diff --git a/git/refs/reference.py b/git/refs/reference.py
@@ -25,7 +25,7 @@
 
 
 def require_remote_ref_path(func: Callable[..., _T]) -> Callable[..., _T]:
-    """A decorator raising :class:`TypeError` if we are not a valid remote, based on the
+    """A decorator raising :class:`ValueError` if we are not a valid remote, based on the
     path."""
 
     def wrapper(self: T_References, *args: Any) -> _T:
