ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Improve documentation about Comment filter (#34539)

Browse source 
Include a mention to the decoration option, which allows someone to
specify the character comment to be used.
This commit is contained in:
Cedric Pimenta 2018-01-09 00:07:32 +01:00 committed by scottb
parent 80fb81414b
commit cd1b144c0a
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/docsite/rst/playbooks_filters.rst
View file

@ -666,6 +666,17 @@ Similar way can be applied style for C (``//...``), C block
{{ "Erlang style" | comment('erlang') }} {{ "Erlang style" | comment('erlang') }}
{{ "XML style" | comment('xml') }} {{ "XML style" | comment('xml') }}
If you need a specific comment character that is not included by any of the
above, you can customize it with::
{{ "My Special Case" | comment(decoration="! ") }}
producing::
!
! My Special Case
!
It is also possible to fully customize the comment style:: It is also possible to fully customize the comment style::
{{ "Custom style" | comment('plain', prefix='#######\n#', postfix='#\n#######\n ###\n #') }} {{ "Custom style" | comment('plain', prefix='#######\n#', postfix='#\n#######\n ###\n #') }}