From 46c4ec22d70251c487a1d43c69c455fc2baab4f0 Mon Sep 17 00:00:00 2001
From: George Hickman <george@ghickman.co.uk>
Date: Tue, 7 Mar 2017 12:16:12 +0000
Subject: Document the use of next to throw an exception when hitting EOF

---
 git/repo/base.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'git/repo')

diff --git a/git/repo/base.py b/git/repo/base.py
index fa9cb596..7820fd66 100644
--- a/git/repo/base.py
+++ b/git/repo/base.py
@@ -716,7 +716,7 @@ class Repo(object):
                 # Discard all lines until we find "filename" which is
                 # guaranteed to be the last line
                 while True:
-                    line = next(stream)
+                    line = next(stream)  # will fail if we reach the EOF unexpectedly
                     tag, value = line.split(b' ', 1)
                     if tag == b'filename':
                         orig_filename = value
-- 
cgit v1.2.3