# HG changeset patch
# User Augie Fackler <augie@google.com>
# Date 2015-11-12 01:43:25
# Node ID d527658310867d1df51b6007d4012c5d21ebaec0
# Parent  64187e9a5659f523dd03665bb7778e50a6c5380d

bookmarks: document getbkfile method

I'm working on bmstore again, and this function gave me a moment's
pause. Document it to save future readers from any undue confusion.

diff --git a/mercurial/bookmarks.py b/mercurial/bookmarks.py
--- a/mercurial/bookmarks.py
+++ b/mercurial/bookmarks.py
@@ -61,6 +61,12 @@ class bmstore(dict):
                 raise
 
     def getbkfile(self, repo):
+        """Hook so that extensions that mess with the store can hook bm storage.
+
+        For core, this just handles wether we should see pending
+        bookmarks or the committed ones. Other extensions (like share)
+        may need to tweak this behavior further.
+        """
         bkfile = None
         if 'HG_PENDING' in os.environ:
             try: