Skip to content

Commit ba878ef

Browse files
committed
Reword partial_to_complete_sha_hex note
The git.db.partial_to_complete_sha_hex docstring refers to "AmbiguousObjects", suggesting the existence of an AmbiguousObject type (or an AmbiguousObjects type). Since there appears to be no such type in GitPython (or in gitdb), this seems to have been written in reference to the condition expressed by the AmbiguousObjectName exception, which the note says is not currently able to be raised (such that BadObject is raised instead) in situations where it would apply. Since the connection to that exeception is already clear from context, this commit changes the wording to "ambiguous objects" to avoid being misread as a reference to a Python class of ambiguous objects.
1 parent 8bb882e commit ba878ef

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Diff for: git/db.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def partial_to_complete_sha_hex(self, partial_hexsha: str) -> bytes:
5959
:raise BadObject:
6060
6161
:note: Currently we only raise :class:`BadObject` as git does not communicate
62-
AmbiguousObjects separately.
62+
ambiguous objects separately.
6363
"""
6464
try:
6565
hexsha, _typename, _size = self._git.get_object_header(partial_hexsha)

0 commit comments

Comments
 (0)