entities/adapters.py
branchstable
changeset 8518 153a7c9cdca9
parent 8190 2a3c1b787688
child 8801 86c1a5afbe4e
--- a/entities/adapters.py	Wed Aug 22 14:17:22 2012 +0200
+++ b/entities/adapters.py	Wed Aug 22 14:19:30 2012 +0200
@@ -87,10 +87,20 @@
 
 
 class IFTIndexableAdapter(view.EntityAdapter):
+    """standard adapter to handle fulltext indexing
+
+    .. automethod:: cubicweb.entities.adapters.IFTIndexableAdapter.fti_containers
+    .. automethod:: cubicweb.entities.adapters.IFTIndexableAdapter.get_words
+    """
     __regid__ = 'IFTIndexable'
     __select__ = is_instance('Any')
 
     def fti_containers(self, _done=None):
+        """return the list of entities to index when handling ``self.entity``
+
+        The actual list of entities depends on ``fulltext_container`` usage
+        in the datamodel definition
+        """
         if _done is None:
             _done = set()
         entity = self.entity