Skip to content

Applied third batch of enhancements for 6.0 #420

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

Merged
merged 2 commits into from
Oct 24, 2022
Merged

Applied third batch of enhancements for 6.0 #420

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
a078a4f
First batch of updates
julian-cable Oct 20, 2022
cbdb412
Remaining enhancements
julian-cable Oct 20, 2022
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
12 changes: 12 additions & 0 deletions en-US/Design.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -896,6 +896,12 @@ $ vi myFile.txt
</para>

</listitem>
<listitem>
<para>
Between a numeral and a unit of measurement.
</para>

</listitem>

</itemizedlist>
<para>
Expand All @@ -914,6 +920,12 @@ $ vi myFile.txt
</para>

</listitem>
<listitem>
<para>
The <systemitem>crashkernel=auto</systemitem> setting requires at least 1&#123;nbsp&#125;GB of memory.
</para>

</listitem>

</itemizedlist>

Expand Down
12 changes: 12 additions & 0 deletions en-US/Grammar.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,18 @@
<para>
The <guibutton>Start</guibutton> button, which you can find in the bottom left corner of your screen (also activated by the "Windows key" on your keyboard, the one between the <keycap>Ctrl</keycap> and <keycap>Alt</keycap> keys), provides a central starting point for applications and tasks, and can be customized according to your individual preferences so that it presents menu items relevant to you instead of presenting the standard items that come with the default installation of the operating system, items which, in my opinion, are irrelevant for most users these days who really only need access to an internet browser such as Google Chrome or Mozilla Firefox.
</para>

<formalpara id="preposition">
<title>Preposition at the End of a Sentence</title>
<para>
Allow a preposition at the end of a sentence to avoid otherwise awkward wording.
</para>

</formalpara>
<para>
For example, instead of "Click the workspace to which you want to switch", which can sound stilted, it flows better to use "Click the workspace to switch to".
</para>

<formalpara id="run-on">
<title>Run-on Sentences</title>
<para>
Expand Down
41 changes: 41 additions & 0 deletions en-US/Language.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1248,6 +1248,47 @@

</listitem>

</varlistentry>
<varlistentry id="there-is">
<term>Use of "There Is" and "There Are"</term>
<listitem>
<para>
Avoid "there is", "there are", and "there might be", because the subject of the sentence is unclear.
</para>

<table>
<title></title>
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="c1"></colspec>
<colspec colname="c2"></colspec>
<thead>
<row>
<entry> Example </entry>
<entry> Improvement </entry>

</row>

</thead>
<tbody>
<row>
<entry> The initial error message suggests there is a failure when opening a file. </entry>
<entry> The initial error message suggests a failure when opening a file. </entry>

</row>
<row>
<entry> There are multiple static inventory formats supported by Ansible. </entry>
<entry> Ansible supports multiple static inventory formats. </entry>

</row>

</tbody>

</tgroup>

</table>

</listitem>

</varlistentry>
<varlistentry id="using">
<term>Use of "Using"</term>
Expand Down
13 changes: 13 additions & 0 deletions en-US/Punctuation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,19 @@
If the contents of the parentheses include at least one complete sentence, the period goes inside the parentheses. If not, the period goes outside.
</para>

</section>
<section id="slashes">
<title>Slashes</title>
<para>
Avoid use of a slash character to mean either of two options.
</para>
<para>
For example, instead of "enable/disable", use "enable or disable".
</para>
<para>
Instead of "A and/or B", use "A or B", or "A, or B, or both".
</para>

</section>
<section id="quotation-marks">
<title>Quotation Marks</title>
Expand Down
25 changes: 25 additions & 0 deletions en-US/W.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,31 @@
</listitem>

</varlistentry>

<varlistentry id="whether">
<term>whether</term>
<listitem>
<para>
Use “whether” instead of “if” to refer to a choice or to alternatives.
Copy link
Contributor

Choose a reason for hiding this comment

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

Interesting, I suspect this one might be hard for me to remember. :)

For example, instead of "Test if authenticated FTP access is restored", write "Test whether authenticated FTP access is restored".
</para>

</listitem>

</varlistentry>

<varlistentry id="while">
<term>while</term>
<listitem>
<para>
In technical content, use “while” only to indicate that many tasks or processes occur at the same time.
For example, instead of "While most targets use one target portal group (TPG), advanced configurations might define multiple TPGs", write "Although most targets use one target portal group (TPG), advanced configurations might define multiple TPGs".
</para>

</listitem>

</varlistentry>

<!-- Added for inclusive language -->
<varlistentry id="whitelist">
<term>whitelist</term>
Expand Down