changeset 45896:e359af6517ce

context: small update to ctx.status doc The order of the "arguments" were not too clear, so we update the documentation to clarify that.
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Fri, 20 Nov 2020 07:37:09 +0100
parents fc4fb2f17dd4
children 063cf294d5e0
files mercurial/context.py
diffstat 1 files changed, 11 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/context.py	Mon Nov 16 16:00:50 2020 -0800
+++ b/mercurial/context.py	Fri Nov 20 07:37:09 2020 +0100
@@ -398,7 +398,17 @@
 
         If other is None, compare this node with working directory.
 
-        returns (modified, added, removed, deleted, unknown, ignored, clean)
+        ctx1.status(ctx2) returns the status of change from ctx1 to ctx2
+
+        Returns a mercurial.scmutils.status object.
+
+        Data can be accessed using either tuple notation:
+
+            (modified, added, removed, deleted, unknown, ignored, clean)
+
+        or direct attribute access:
+
+            s.modified, s.added, ...
         """
 
         ctx1 = self