# HG changeset patch
# User Lucas Moscovicz <lmoscovicz@fb.com>
# Date 1394813894 25200
# Node ID 1e59f760d8508e639759dc89c9b55262470afccc
# Parent  6eb9c4a9a12b59227657edd0eebd17f1fb9ae365
revset: added comments to all methods needed to duck-type from baseset

All this methods are required to duck-type for any class that works as a smart
set.

diff -r 6eb9c4a9a12b -r 1e59f760d850 mercurial/revset.py
--- a/mercurial/revset.py	Fri Mar 14 10:10:18 2014 -0700
+++ b/mercurial/revset.py	Fri Mar 14 09:18:14 2014 -0700
@@ -2171,23 +2171,40 @@
 class baseset(list):
     """Basic data structure that represents a revset and contains the basic
     operation that it should be able to perform.
+
+    Every method in this class should be implemented by any smartset class.
     """
     def __init__(self, data):
         super(baseset, self).__init__(data)
         self._set = None
 
     def ascending(self):
+        """Sorts the set in ascending order (in place).
+
+        This is part of the mandatory API for smartset."""
         self.sort()
 
     def descending(self):
+        """Sorts the set in descending order (in place).
+
+        This is part of the mandatory API for smartset."""
         self.sort(reverse=True)
 
     def set(self):
+        """Returns a set or a smartset containing all the elements.
+
+        The returned structure should be the fastest option for membership
+        testing.
+
+        This is part of the mandatory API for smartset."""
         if not self._set:
             self._set = set(self)
         return self._set
 
     def __sub__(self, other):
+        """Returns a new object with the substraction of the two collections.
+
+        This is part of the mandatory API for smartset."""
         if isinstance(other, baseset):
             s = other.set()
         else:
@@ -2195,22 +2212,40 @@
         return baseset(self.set() - s)
 
     def __and__(self, other):
+        """Returns a new object with the intersection of the two collections.
 
+        This is part of the mandatory API for smartset."""
         if isinstance(other, baseset):
             other = other.set()
         return baseset([y for y in self if y in other])
+
     def __add__(self, other):
+        """Returns a new object with the union of the two collections.
+
+        This is part of the mandatory API for smartset."""
         s = self.set()
         l = [r for r in other if r not in s]
         return baseset(list(self) + l)
 
     def isascending(self):
+        """Returns True if the collection is ascending order, False if not.
+
+        This is part of the mandatory API for smartset."""
         return False
 
     def isdescending(self):
+        """Returns True if the collection is descending order, False if not.
+
+        This is part of the mandatory API for smartset."""
         return False
 
     def filter(self, condition):
+        """Returns this smartset filtered by condition as a new smartset.
+
+        `condition` is a callable which takes a revision number and returns a
+        boolean.
+
+        This is part of the mandatory API for smartset."""
         return lazyset(self, condition)
 
 class lazyset(object):