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
--- a/mercurial/pure/parsers.py Fri Jul 02 02:17:31 2021 +0200
+++ b/mercurial/pure/parsers.py Fri Jul 02 02:36:07 2021 +0200
@@ -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