Document via comment.

Maybe it's time for type annotations 😛
zopefoundation · Dec 6, 2019 · a7f401b · a7f401b
1 parent 6138fb9
commit a7f401b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/Products/ZCatalog/ZCatalog.py b/src/Products/ZCatalog/ZCatalog.py
@@ -410,6 +410,8 @@ def manage_clearIndex(self, ids=None,
 
     @security.protected(manage_zcatalog_entries)
     def reindexIndex(self, name, REQUEST, pghandler=None):
+        # This method does the actual reindexing of indexes.
+        # `name` can be the name of an index of a list of names.
         idxs = (name, ) if isinstance(name, str) else name
         paths = self._catalog.uids.keys()