From 5b16e012a49b81c2aa87bb777a5ed05328187c40 Mon Sep 17 00:00:00 2001 From: Brett Campbell Date: Thu, 22 Aug 2019 12:29:53 -0700 Subject: [PATCH] Doc fixes for readability (formatting/punctuation) (#61086) Variable-width font was extremely difficult to read in a couple places. Fixed missing close-quote, colon, spelling, etc. --- docs/docsite/rst/user_guide/intro_patterns.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/docsite/rst/user_guide/intro_patterns.rst b/docs/docsite/rst/user_guide/intro_patterns.rst index dc83584bf6d..8360eb90a2a 100644 --- a/docs/docsite/rst/user_guide/intro_patterns.rst +++ b/docs/docsite/rst/user_guide/intro_patterns.rst @@ -52,16 +52,16 @@ You can do combinations:: webservers:dbservers:&staging:!phoenix -The above configuration means "all machines in the groups 'webservers' and 'dbservers' are to be managed if they are in -the group 'staging' also, but the machines are not to be managed if they are in the group 'phoenix' ... whew! +The above configuration means "all machines in the groups 'webservers' and 'dbservers' are to be managed if they are also in +the group 'staging', but the machines are not to be managed if they are in the group 'phoenix'." Whew! -You can also use variables if you want to pass some group specifiers via the "-e" argument to ansible-playbook, but this +You can also use variables if you want to pass some group specifiers via the ``-e`` argument to ansible-playbook, but this is uncommonly used:: webservers:!{{excluded}}:&{{required}} -You also don't have to manage by strictly defined groups. Individual host names, IPs and groups, can also be referenced using -wildcards +You also don't have to manage by strictly defined groups. Individual host names, IPs, and groups can also be referenced using +wildcards: .. code-block:: none @@ -88,7 +88,7 @@ You can refer to hosts within the group by adding a subscript to the group name: webservers[1:] # == webbing,weber webservers[:3] # == cobweb,webbing,weber -Most people don't specify patterns as regular expressions, but you can. Just start the pattern with a '~':: +Most people don't specify patterns as regular expressions, but you can. Just start the pattern with a ``~``:: ~(web|db).*\.example\.com @@ -96,13 +96,13 @@ While we're jumping a bit ahead, additionally, you can add an exclusion criteria ansible-playbook site.yml --limit datacenter2 -And if you want to read the list of hosts from a file, prefix the file name with '@'.:: +And if you want to read the list of hosts from a file, prefix the file name with ``@``:: ansible-playbook site.yml --limit @retry_hosts.txt Easy enough. See :ref:`intro_adhoc` and then :ref:`playbooks_intro` for how to apply this knowledge. -.. note:: You can use ',' instead of ':' as a host list separator. The ',' is preferred specially when dealing with ranges and ipv6. +.. note:: You can use a comma (``,``) as a host list separator instead of a colon (``:``). The comma is preferred when dealing with ranges and IPv6 addresses. .. seealso::