Clarify costs of certain properties

Byron · Byron · commit 2376bd397f08 · 2016-05-19T13:09:51.000+02:00
Fixes #428
diff --git a/git/repo/base.py b/git/repo/base.py
@@ -254,7 +254,9 @@ def references(self):
 
     @property
     def index(self):
-        """:return: IndexFile representing this repository's index."""
+        """:return: IndexFile representing this repository's index.
+        :note: This property can be expensive, as the returned ``IndexFile`` will be
+         reinitialized. It's recommended to re-use the object."""
         return IndexFile(self)
 
     @property
@@ -624,7 +626,10 @@ def untracked_files(self):
             are relative to the current working directory of the git command.
 
         :note:
-            ignored files will not appear here, i.e. files mentioned in .gitignore"""
+            ignored files will not appear here, i.e. files mentioned in .gitignore
+        :note:
+            This property is expensive, as no cache is involved. To process the result, please 
+            consider caching it yourself."""
         return self._get_untracked_files()
 
     def _get_untracked_files(self, **kwargs):
