Commits

Fredrik Håård  committed a3de019

Documented hg_status

  • Participants
  • Parent commits f1d7e87

Comments (0)

Files changed (1)

File hgapi/hgapi.py

         return self.hg_command(*cmds)
         
     def hg_status(self):
+        """Get repository status.
+        Returns a dict containing a *change char* -> *file list* mapping, where 
+        change char is in A, M, R, !, ?
+
+        Example - added one.txt, modified a_folder/two.txt and three.txt: 
+            {'A': ['one.txt'], 'M': ['a_folder/two.txt', 'three.txt']}
+
+        Note that empty mappings are not created.
+        """
         cmds = ['status']
         out = self.hg_command(*cmds).strip()
         if not out: return {}