added clarification on the return type for a router

disqus · Feb 17, 2012 · fac1b0f · fac1b0f
1 parent 855ac55
commit fac1b0f
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/nydus/db/routers/__init__.py b/nydus/db/routers/__init__.py
@@ -16,6 +16,9 @@ class BaseRouter(object):
     retryable = False
 
     def get_db(self, cluster, func, *args, **kwargs):
-        """Return the first entry in the cluster"""
+        """
+        Return the first entry in the cluster
+        The return value must be iterable
+        """
         return range(len(cluster))