evolve: improve the confusing docstring for _orderrevs() stable
authorGreg Ward <greg@gerg.ca>
Sat, 07 Nov 2015 13:37:26 -0500
branchstable
changeset 1571 0e8936e7cb89
parent 1570 0edb2c25f806
child 1572 44e9c0a264de
evolve: improve the confusing docstring for _orderrevs()
hgext/evolve.py
--- a/hgext/evolve.py	Sat Nov 07 09:48:04 2015 -0500
+++ b/hgext/evolve.py	Sat Nov 07 13:37:26 2015 -0500
@@ -1497,14 +1497,14 @@
 def _orderrevs(repo, revs):
     """Compute an ordering to solve instability for the given revs
 
-    - Takes revs a list of instable revisions
-
-    - Returns the same revisions ordered to solve their instability from the
+    revs is a list of unstable revisions.
+
+    Returns the same revisions ordered to solve their instability from the
     bottom to the top of the stack that the stabilization process will produce
     eventually.
 
-    This ensure the minimal number of stabilization as we can stabilize each
-    revision on its final, stabilized, destination.
+    This ensures the minimal number of stabilizations, as we can stabilize each
+    revision on its final stabilized destination.
     """
     # Step 1: Build the dependency graph
     dependencies, rdependencies = builddependencies(repo, revs)