diff mercurial/scmutil.py @ 22915:4d680deb0d9e

status: update and move documentation of status types to status class The various status types are currently documented on the dirstate.status() method. Now that we have a class for the status types, it makese sense to document the status types there instead. Only leave the bits related to lookup/unsure in the status() method documentation.
author Martin von Zweigbergk <martinvonz@gmail.com>
date Fri, 10 Oct 2014 10:14:35 -0700
parents cb4449921a1d
children c4ce077588d0
line wrap: on
line diff
--- a/mercurial/scmutil.py	Tue Oct 14 00:52:27 2014 -0500
+++ b/mercurial/scmutil.py	Fri Oct 10 10:14:35 2014 -0700
@@ -34,30 +34,39 @@
 
     @property
     def modified(self):
+        '''files that have been modified'''
         return self[0]
 
     @property
     def added(self):
+        '''files that have been added'''
         return self[1]
 
     @property
     def removed(self):
+        '''files that have been removed'''
         return self[2]
 
     @property
     def deleted(self):
+        '''files that are in the dirstate, but have been deleted from the
+           working copy (aka "missing")
+        '''
         return self[3]
 
     @property
     def unknown(self):
+        '''files not in the dirstate that are not ignored'''
         return self[4]
 
     @property
     def ignored(self):
+        '''files not in the dirstate that are ignored (by _dirignore())'''
         return self[5]
 
     @property
     def clean(self):
+        '''files that have not been modified'''
         return self[6]
 
     def __repr__(self, *args, **kwargs):