templater: rewrite docstring of templater.__init__()
authorYuya Nishihara <yuya@tcha.org>
Fri, 22 Dec 2017 21:12:17 +0900
changeset 35481 964510dcdc2a
parent 35480 01b084914a60
child 35482 c240657febb7
templater: rewrite docstring of templater.__init__() More importantly, this patch adds what the cache is.
mercurial/templater.py
--- a/mercurial/templater.py	Fri Dec 22 00:44:36 2017 -0600
+++ b/mercurial/templater.py	Fri Dec 22 21:12:17 2017 +0900
@@ -1434,13 +1434,19 @@
 
     def __init__(self, filters=None, defaults=None, resources=None,
                  cache=None, aliases=(), minchunk=1024, maxchunk=65536):
-        '''set up template engine.
-        filters is dict of functions. each transforms a value into another.
-        defaults is dict of default map definitions.
-        resources is dict of internal data (e.g. cache), which are inaccessible
-        from user template.
-        aliases is list of alias (name, replacement) pairs.
-        '''
+        """Create template engine optionally with preloaded template fragments
+
+        - ``filters``: a dict of functions to transform a value into another.
+        - ``defaults``: a dict of symbol values/functions; may be overridden
+          by a ``mapping`` dict.
+        - ``resources``: a dict of internal data (e.g. cache), inaccessible
+          from user template; may be overridden by a ``mapping`` dict.
+        - ``cache``: a dict of preloaded template fragments.
+        - ``aliases``: a list of alias (name, replacement) pairs.
+
+        self.cache may be updated later to register additional template
+        fragments.
+        """
         if filters is None:
             filters = {}
         if defaults is None: