Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated Boolean guidance and a bug fix #551

Merged
merged 2 commits into from
Dec 22, 2023
Merged

Updated Boolean guidance and a bug fix #551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca83a5b
Updated Boolean guidance and a bug fix
julian-cable Dec 20, 2023
e6a2ab9
Update to Boolean entry
julian-cable Dec 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions en-US/B.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,9 +227,18 @@
Correct. Named after George Boole, who first developed the concept.
</para>
<para>
According to the <citetitle>IBM Style Guide</citetitle>, it is acceptable to use "boolean" in API programming information when it refers to a primitive return type.
According to the <citetitle>IBM Style Guide</citetitle>, it is acceptable to use "boolean" (lowercase) in API programming information when it refers to a primitive return type.
</para>

<para>
To set Boolean values in YAML files, use <varname>true</varname> or <varname>false</varname>, written lowercase, rather than <varname>yes</varname> or <varname>no</varname>, because YAML&nbsp;1.2 and later versions do not support the latter syntax.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is fine. We'll probably eventually have guidance that aligns with ansible-navigator lint or some of those things that touch upon Ansible.

</para>
<para>
For example, the following scenario specifies that a task is run only one time:
</para>
<screen>- name: Pause 30 seconds
ansible.builtin.pause:
seconds: 30
<userinput>run_once: true</userinput></screen>
</listitem>

</varlistentry>
Expand Down
2 changes: 1 addition & 1 deletion en-US/Grammar.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -932,7 +932,7 @@ Split contractions and abbreviations into separate paragraphs. -->
<title>Contractions and Abbreviations</title>
<para>
Do not use contractions in Red&nbsp;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.
Expand Down