match: document bad callback semantics
authorMatt Mackall <mpm@selenic.com>
Sun, 31 May 2009 17:54:18 -0500
changeset 8678 43598055bae8
parent 8677 34df078b8b1b
child 8679 32537b12e091
match: document bad callback semantics
mercurial/match.py
--- a/mercurial/match.py	Sun May 31 17:54:18 2009 -0500
+++ b/mercurial/match.py	Sun May 31 17:54:18 2009 -0500
@@ -81,6 +81,13 @@
         for f in self._files:
             yield f
     def bad(self, f, msg):
+        '''callback for each explicit file that can't be
+        found/accessed, with an error message
+
+        return True to keep file in results, False to discard
+
+        default behavior is to silently keep
+        '''
         return True
     def dir(self, f):
         pass