D10935: dirstate: document the dirstatetuple content

[marmoute (Pierre-Yves David)]

marmoute created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  We are about to modify this, so let us document the existing code.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D10935

AFFECTED FILES
  mercurial/pure/parsers.py

CHANGE DETAILS

diff --git a/mercurial/pure/parsers.py b/mercurial/pure/parsers.py
--- a/mercurial/pure/parsers.py
+++ b/mercurial/pure/parsers.py
@@ -35,6 +35,13 @@
 # Some code below makes tuples directly because it's more convenient. However,
 # code outside this module should always use dirstatetuple.
 def dirstatetuple(*x):
+    """the four items are:
+    - state (one of 'n', 'a', 'r', 'm')
+    - mode,
+    - size,
+    - mtime,
+    """
+
     # x is a tuple
     return x
 



To: marmoute, #hg-reviewers
Cc: mercurial-patches, mercurial-devel