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