[PATCH] status: document the content of the returned tuple in the docstring

pierre-yves.david at ens-lyon.org pierre-yves.david at ens-lyon.org
Mon Jun 2 14:50:50 CDT 2014


# HG changeset patch
# User Pierre-Yves David <pierre-yves.david at fb.com>
# Date 1401582375 25200
#      Sat May 31 17:26:15 2014 -0700
# Node ID 207b1106205fda34de19508ea8846d199f59bfe7
# Parent  25732fab4dc35a76cfb8f659fde48c7e0dc42dbf
status: document the content of the returned tuple in the docstring

The ``status`` function returns a lot of information. We document it.

diff --git a/mercurial/context.py b/mercurial/context.py
--- a/mercurial/context.py
+++ b/mercurial/context.py
@@ -273,10 +273,12 @@ class basectx(object):
                listclean=False, listunknown=False, listsubrepos=False):
         """return status of files between two nodes or node and working
         directory.
 
         If other is None, compare this node with working directory.
+
+        returns (modified, added, removed, deleted, unknown, ignored, clean)
         """
 
         ctx1 = self
         ctx2 = self._repo[other]
 


More information about the Mercurial-devel mailing list