diff hgext3rd/evolve/__init__.py @ 5808:53dbe425d249

evolve: document provided revset predicates

--- a/hgext3rd/evolve/__init__.py	Sat Feb 27 18:22:12 2021 +0800
+++ b/hgext3rd/evolve/__init__.py	Sat Feb 27 19:13:04 2021 +0800
@@ -188,6 +188,28 @@
   - precursors (deprecated, use predecessors instead)
   - successors (deprecated, use successorssets instead)
   - troubles (deprecated, use instabilities instead)
+
+Revset predicates
+-----------------
+
+Evolve provides several revset predicates:
+
+  - unstable
+  - troubled (deprecated, use unstable instead)
+  - suspended
+  - predecessors
+  - precursors (deprecated, use predecessors instead)
+  - allpredecessors
+  - allprecursors (deprecated, use allpredecessors instead)
+  - successors
+  - allsuccessors
+
+Note that successors revset in evolve is not the same as successors revset in
+core Mercurial 4.3+. In evolve this revset returns only immediate successors,
+as opposed to all successors. Use "allsuccessors(set)" to obtain all
+successors.
+
+See :hg:`help revsets -v` for more information.
 """
 
 evolutionhelptext = b"""