# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 2021-07-02 00:36:07
# Node ID 084ed6a7c6fda8ca09226a7d53c147292490fdeb
# Parent  4a7df782f416017f6eb9f55772f426e51808c198

dirstate: document the dirstatetuple content

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

Differential Revision: https://phab.mercurial-scm.org/D10935

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 @@ stringio = pycompat.bytesio
 # 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