Commit 618c66a1 authored by Vincent Pelletier's avatar Vincent Pelletier

Stop documenting json and jsonkey context types.

They should not be needed when buildout handles its own serialisation.
parent 320f29b2
......@@ -19,8 +19,6 @@ Example buildout demonstrating some types::
... key bar section:key
... key recipe :recipe
... raw knight Ni !
... json words ["Peng", "Neee-wom"]
... jsonkey later section:later-words
... import json_module json
... section param_dict parameter-collection
...
......@@ -30,15 +28,13 @@ Example buildout demonstrating some types::
...
... [section]
... key = value
... later-words = "Ekke Ekke Ekke Ekke Ptangya Ziiinnggggggg Ni!"
... ''')
And according Jinja2 template (kept simple, control structures are possible)::
>>> write('foo.in',
... '{{bar}}\n'
... 'Knights who say "{{knight}}" also protect {{ words | join(", ") }}.\n'
... 'They later say {{later}}\n'
... 'Knights who say "{{knight}}"\n'
... '${this:is_literal}\n'
... '${foo:{{bar}}}\n'
... 'swallow: {{ json_module.dumps(("african", "european")) }}\n'
......@@ -55,8 +51,7 @@ And the template has been rendered::
>>> cat('foo')
value
Knights who say "Ni !" also protect Peng, Neee-wom.
They later say Ekke Ekke Ekke Ekke Ptangya Ziiinnggggggg Ni!
Knights who say "Ni !"
${this:is_literal}
${foo:value}
swallow: ["african", "european"]
......@@ -87,15 +82,9 @@ Optional:
``raw``
Immediate literal string.
``json``
Immediate json-encoded string. (deprecated)
``key``
Indirect literal string.
``jsonkey``
Indirect json-encoded string. (deprecated)
``import``
Import a python module.
......@@ -104,9 +93,9 @@ Optional:
Indirection targets are specified as: [section]:key .
It is possible to use buildout's buit-in variable replacement instead instead
of ``key`` or ``jsonkey`` types, but keep in mind that different lines are
different variables for this recipe. It might be what you want (factorising
context chunk declarations), otherwise you should use indirect types.
of ``key`` type, but keep in mind that different lines are different
variables for this recipe. It might be what you want (factorising context
chunk declarations), otherwise you should use indirect types.
``md5sum``
Template's MD5, for file integrity checking. By default, no integrity check
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment