From ca83a5b3f9cf75ba602c39d29cbf4085ebc4d224 Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Wed, 20 Dec 2023 22:56:38 +0000 Subject: [PATCH 1/2] Updated Boolean guidance and a bug fix --- en-US/B.xml | 11 ++++++++++- en-US/Grammar.xml | 2 +- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/en-US/B.xml b/en-US/B.xml index af67e4c..a34f57e 100644 --- a/en-US/B.xml +++ b/en-US/B.xml @@ -229,7 +229,16 @@ According to the IBM Style Guide, it is acceptable to use "boolean" in API programming information when it refers to a primitive return type. - + + To set Boolean values in YAML files, use true or false, written lowercase, rather than yes or no, because YAML 1.2 and later versions do not support the latter syntax. + + + For example, the following scenario specifies that a task is run only one time: + +- name: Pause 30 seconds + ansible.builtin.pause: + seconds: 30 + run_once: true diff --git a/en-US/Grammar.xml b/en-US/Grammar.xml index fe7ebfd..e882786 100644 --- a/en-US/Grammar.xml +++ b/en-US/Grammar.xml @@ -932,7 +932,7 @@ Split contractions and abbreviations into separate paragraphs. --> Contractions and Abbreviations Do not use contractions in Red Hat documents. - For example, do not use can't, "don't", "won't", and similar examples. + For example, do not use "can't", "don't", "won't", and similar examples. Write out the words in full. Contractions are a mark of informal writing, and should be avoided when writing technical documentation or other more formal types of manuals. They can also cause problems for translation. From e6a2ab9d9f8d2520ff691205c33ba0dd3a580ba4 Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Fri, 22 Dec 2023 00:55:47 +0000 Subject: [PATCH 2/2] Update to Boolean entry --- en-US/B.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en-US/B.xml b/en-US/B.xml index a34f57e..b72d4c5 100644 --- a/en-US/B.xml +++ b/en-US/B.xml @@ -227,7 +227,7 @@ Correct. Named after George Boole, who first developed the concept. - According to the IBM Style Guide, it is acceptable to use "boolean" in API programming information when it refers to a primitive return type. + According to the IBM Style Guide, it is acceptable to use "boolean" (lowercase) in API programming information when it refers to a primitive return type. To set Boolean values in YAML files, use true or false, written lowercase, rather than yes or no, because YAML 1.2 and later versions do not support the latter syntax.