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

docs_pull_request: Add parameters highlighting

Added highlighting to parameter references in docs so that they standout a bit better.
This commit is contained in:
mxxcon 2014-02-15 23:26:21 -05:00
parent 5d686a459c
commit 4e4be3edc0

View file

@ -58,8 +58,8 @@ options:
required: false required: false
description: description:
- Required for C(state=present). The line to insert/replace into the - Required for C(state=present). The line to insert/replace into the
file. If backrefs is set, may contain backreferences that will get file. If C(backrefs) is set, may contain backreferences that will get
expanded with the regexp capture groups if the regexp matches. The expanded with the C(regexp) capture groups if the regexp matches. The
backreferences should be double escaped (see examples). backreferences should be double escaped (see examples).
backrefs: backrefs:
required: false required: false
@ -68,11 +68,11 @@ options:
version_added: "1.1" version_added: "1.1"
description: description:
- Used with C(state=present). If set, line can contain backreferences - Used with C(state=present). If set, line can contain backreferences
(both positional and named) that will get populated if the regexp (both positional and named) that will get populated if the C(regexp)
matches. This flag changes the operation of the module slightly; matches. This flag changes the operation of the module slightly;
insertbefore and insertafter will be ignored, and if the regexp C(insertbefore) and C(insertafter) will be ignored, and if the C(regexp)
doesn't match anywhere in the file, the file will be left unchanged. doesn't match anywhere in the file, the file will be left unchanged.
If the regexp does match, the last matching line will be replaced by If the C(regexp) does match, the last matching line will be replaced by
the expanded line parameter. the expanded line parameter.
insertafter: insertafter:
required: false required: false
@ -81,7 +81,7 @@ options:
- Used with C(state=present). If specified, the line will be inserted - Used with C(state=present). If specified, the line will be inserted
after the specified regular expression. A special value is after the specified regular expression. A special value is
available; C(EOF) for inserting the line at the end of the file. available; C(EOF) for inserting the line at the end of the file.
May not be used with backrefs. May not be used with C(backrefs).
choices: [ 'EOF', '*regex*' ] choices: [ 'EOF', '*regex*' ]
insertbefore: insertbefore:
required: false required: false
@ -90,7 +90,7 @@ options:
- Used with C(state=present). If specified, the line will be inserted - Used with C(state=present). If specified, the line will be inserted
before the specified regular expression. A value is available; before the specified regular expression. A value is available;
C(BOF) for inserting the line at the beginning of the file. C(BOF) for inserting the line at the beginning of the file.
May not be used with backrefs. May not be used with C(backrefs).
choices: [ 'BOF', '*regex*' ] choices: [ 'BOF', '*regex*' ]
create: create:
required: false required: false