src/pyams_content/shared/view/interfaces.py
changeset 1217 ac40004d7c73
parent 1207 a97f2023131a
child 1233 85bbcd5fa922
--- a/src/pyams_content/shared/view/interfaces.py	Mon Jan 07 11:36:09 2019 +0100
+++ b/src/pyams_content/shared/view/interfaces.py	Tue Jan 08 14:02:06 2019 +0100
@@ -168,7 +168,13 @@
     """View query extension interface"""
 
     def get_params(self, context, request=None):
-        """Add params to catalog query"""
+        """Add params to catalog query
+
+        This method may return an iterator.
+        If defined settings are such that no result can be found (for example, if the view is
+        defined to use context themes but context doesn't have any), method can yield a "None"
+        value which will cancel query execution.
+        """
 
 
 class IViewQueryEsParamsExtension(IViewQueryExtension):