瀏覽代碼

Clarify doc string for Index.__getitem__

Fixes #1205
Jelmer Vernooij 1 年之前
父節點
當前提交
44ae356051
共有 1 個文件被更改,包括 2 次插入2 次删除
  1. 2 2
      dulwich/index.py

+ 2 - 2
dulwich/index.py

@@ -455,8 +455,8 @@ class Index:
     def __getitem__(self, key: bytes) -> Union[IndexEntry, ConflictedIndexEntry]:
     def __getitem__(self, key: bytes) -> Union[IndexEntry, ConflictedIndexEntry]:
         """Retrieve entry by relative path and stage.
         """Retrieve entry by relative path and stage.
 
 
-        Returns: tuple with (ctime, mtime, dev, ino, mode, uid, gid, size, sha,
+        Returns: Either a IndexEntry or a ConflictedIndexEntry
-            flags)
+        Raises KeyError: if the entry does not exist
         """
         """
         return self._byname[key]
         return self._byname[key]