Skip to content

Commit be533cf

Browse files
julian-cablejulian-cable
authored
Applied third batch of enhancements for 6.0 (#420)
* First batch of updates * Remaining enhancements
1 parent 2048498 commit be533cf

File tree

5 files changed

+103
-0
lines changed

5 files changed

+103
-0
lines changed

‎en-US/Design.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -896,6 +896,12 @@ $ vi myFile.txt
896896
</para>
897897

898898
</listitem>
899+
<listitem>
900+
<para>
901+
Between a numeral and a unit of measurement.
902+
</para>
903+
904+
</listitem>
899905

900906
</itemizedlist>
901907
<para>
@@ -914,6 +920,12 @@ $ vi myFile.txt
914920
</para>
915921

916922
</listitem>
923+
<listitem>
924+
<para>
925+
The <systemitem>crashkernel=auto</systemitem> setting requires at least 1&#123;nbsp&#125;GB of memory.
926+
</para>
927+
928+
</listitem>
917929

918930
</itemizedlist>
919931

‎en-US/Grammar.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,18 @@
268268
<para>
269269
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.
270270
</para>
271+
272+
<formalpara id="preposition">
273+
<title>Preposition at the End of a Sentence</title>
274+
<para>
275+
Allow a preposition at the end of a sentence to avoid otherwise awkward wording.
276+
</para>
277+
278+
</formalpara>
279+
<para>
280+
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".
281+
</para>
282+
271283
<formalpara id="run-on">
272284
<title>Run-on Sentences</title>
273285
<para>

‎en-US/Language.xml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1248,6 +1248,47 @@
12481248

12491249
</listitem>
12501250

1251+
</varlistentry>
1252+
<varlistentry id="there-is">
1253+
<term>Use of "There Is" and "There Are"</term>
1254+
<listitem>
1255+
<para>
1256+
Avoid "there is", "there are", and "there might be", because the subject of the sentence is unclear.
1257+
</para>
1258+
1259+
<table>
1260+
<title></title>
1261+
<tgroup cols="2" colsep="1" rowsep="1">
1262+
<colspec colname="c1"></colspec>
1263+
<colspec colname="c2"></colspec>
1264+
<thead>
1265+
<row>
1266+
<entry> Example </entry>
1267+
<entry> Improvement </entry>
1268+
1269+
</row>
1270+
1271+
</thead>
1272+
<tbody>
1273+
<row>
1274+
<entry> The initial error message suggests there is a failure when opening a file. </entry>
1275+
<entry> The initial error message suggests a failure when opening a file. </entry>
1276+
1277+
</row>
1278+
<row>
1279+
<entry> There are multiple static inventory formats supported by Ansible. </entry>
1280+
<entry> Ansible supports multiple static inventory formats. </entry>
1281+
1282+
</row>
1283+
1284+
</tbody>
1285+
1286+
</tgroup>
1287+
1288+
</table>
1289+
1290+
</listitem>
1291+
12511292
</varlistentry>
12521293
<varlistentry id="using">
12531294
<term>Use of "Using"</term>

‎en-US/Punctuation.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,19 @@
422422
If the contents of the parentheses include at least one complete sentence, the period goes inside the parentheses. If not, the period goes outside.
423423
</para>
424424

425+
</section>
426+
<section id="slashes">
427+
<title>Slashes</title>
428+
<para>
429+
Avoid use of a slash character to mean either of two options.
430+
</para>
431+
<para>
432+
For example, instead of "enable/disable", use "enable or disable".
433+
</para>
434+
<para>
435+
Instead of "A and/or B", use "A or B", or "A, or B, or both".
436+
</para>
437+
425438
</section>
426439
<section id="quotation-marks">
427440
<title>Quotation Marks</title>

‎en-US/W.xml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,31 @@
9292
</listitem>
9393

9494
</varlistentry>
95+
96+
<varlistentry id="whether">
97+
<term>whether</term>
98+
<listitem>
99+
<para>
100+
Use “whether” instead of “if” to refer to a choice or to alternatives.
101+
For example, instead of "Test if authenticated FTP access is restored", write "Test whether authenticated FTP access is restored".
102+
</para>
103+
104+
</listitem>
105+
106+
</varlistentry>
107+
108+
<varlistentry id="while">
109+
<term>while</term>
110+
<listitem>
111+
<para>
112+
In technical content, use “while” only to indicate that many tasks or processes occur at the same time.
113+
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".
114+
</para>
115+
116+
</listitem>
117+
118+
</varlistentry>
119+
95120
<!-- Added for inclusive language -->
96121
<varlistentry id="whitelist">
97122
<term>whitelist</term>

0 commit comments

Comments
 (0)