Skip to content

Commit 2dbe3ea

Browse files
bmomjianbmomjian
committed
doc: add commas after 'i.e.' and 'e.g.'
This follows the American format, https://jakubmarian.com/comma-after-i-e-and-e-g/. There is no intention of requiring this format for future text, but making existing text consistent every few years makes sense. Discussion: https://postgr.es/m/20200825183619.GA22369@momjian.us Backpatch-through: 9.5
1 parent fd9451d commit 2dbe3ea

39 files changed

+89
-89
lines changed

‎doc/src/sgml/config.sgml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ include_dir 'directory'
407407
start with the <literal>.</literal> character are also ignored, to
408408
prevent mistakes since such files are hidden on some platforms. Multiple
409409
files within an include directory are processed in file name order
410-
(according to C locale rules, i.e. numbers before letters, and
410+
(according to C locale rules, i.e., numbers before letters, and
411411
uppercase letters before lowercase ones).
412412
</para>
413413

@@ -1259,7 +1259,7 @@ include_dir 'conf.d'
12591259
<para>
12601260
With this parameter enabled, you can still create ordinary global
12611261
users. Simply append <literal>@</> when specifying the user
1262-
name in the client, e.g. <literal>joe@</>. The <literal>@</>
1262+
name in the client, e.g., <literal>joe@</>. The <literal>@</>
12631263
will be stripped off before the user name is looked up by the
12641264
server.
12651265
</para>
@@ -2578,7 +2578,7 @@ include_dir 'conf.d'
25782578
disabled, but the server continues to accumulate WAL segment files in
25792579
the expectation that a command will soon be provided. Setting
25802580
<varname>archive_command</> to a command that does nothing but
2581-
return true, e.g. <literal>/bin/true</> (<literal>REM</> on
2581+
return true, e.g., <literal>/bin/true</> (<literal>REM</> on
25822582
Windows), effectively disables
25832583
archiving, but also breaks the chain of WAL files needed for
25842584
archive recovery, so it should only be used in unusual circumstances.
@@ -3362,7 +3362,7 @@ include_dir 'conf.d'
33623362
if your data is likely to be completely in cache, such as when
33633363
the database is smaller than the total server memory, decreasing
33643364
random_page_cost can be appropriate. Storage that has a low random
3365-
read cost relative to sequential, e.g. solid-state drives, might
3365+
read cost relative to sequential, e.g., solid-state drives, might
33663366
also be better modeled with a lower value for random_page_cost,
33673367
e.g., <literal>1.1</literal>.
33683368
</para>
@@ -6665,7 +6665,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
66656665
rows that can be locked; that value is unlimited. The default,
66666666
64, has historically proven sufficient, but you might need to
66676667
raise this value if you have queries that touch many different
6668-
tables in a single transaction, e.g. query of a parent table with
6668+
tables in a single transaction, e.g., query of a parent table with
66696669
many children. This parameter can only be set at server start.
66706670
</para>
66716671

@@ -7170,7 +7170,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
71707170
with assertions enabled. That is the case if the
71717171
macro <symbol>USE_ASSERT_CHECKING</symbol> is defined
71727172
when <productname>PostgreSQL</productname> is built (accomplished
7173-
e.g. by the <command>configure</command> option
7173+
e.g., by the <command>configure</command> option
71747174
<option>--enable-cassert</option>). By
71757175
default <productname>PostgreSQL</productname> is built without
71767176
assertions.

‎doc/src/sgml/cube.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,9 +272,9 @@
272272
</literal></entry>
273273
<entry>Makes a new cube from an existing cube, using a list of
274274
dimension indexes from an array. Can be used to find both the LL and UR
275-
coordinates of a single dimension, e.g.
275+
coordinates of a single dimension, e.g.,
276276
<literal>cube_subset(cube('(1,3,5),(6,7,8)'), ARRAY[2]) = '(3),(7)'</>.
277-
Or can be used to drop dimensions, or reorder them as desired, e.g.
277+
Or can be used to drop dimensions, or reorder them as desired, e.g.,
278278
<literal>cube_subset(cube('(1,3,5),(6,7,8)'), ARRAY[3,2,1,1]) = '(5, 3,
279279
1, 1),(8, 7, 6, 6)'</>.
280280
</entry>

‎doc/src/sgml/datatype.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@
501501
very large number of digits. It is especially recommended for
502502
storing monetary amounts and other quantities where exactness is
503503
required. Calculations with <type>numeric</type> values yield exact
504-
results where possible, e.g. addition, subtraction, multiplication.
504+
results where possible, e.g., addition, subtraction, multiplication.
505505
However, calculations on <type>numeric</type> values are very slow
506506
compared to the integer types, or to the floating-point types
507507
described in the next section.

‎doc/src/sgml/ddl.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1510,7 +1510,7 @@ ALTER TABLE products RENAME TO items;
15101510

15111511
<para>
15121512
An object can be assigned to a new owner with an <command>ALTER</command>
1513-
command of the appropriate kind for the object, e.g. <xref
1513+
command of the appropriate kind for the object, e.g., <xref
15141514
linkend="sql-altertable">. Superusers can always do
15151515
this; ordinary roles can only do it if they are both the current owner
15161516
of the object (or a member of the owning role) and a member of the new

‎doc/src/sgml/docguide.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -683,16 +683,16 @@ save_size.pdfjadetex = 15000
683683

684684
<para>
685685
Occasionally text is too wide for the printed margins, and in
686-
extreme cases, too wide for the printed page, e.g. non-wrapped
686+
extreme cases, too wide for the printed page, e.g., non-wrapped
687687
text, wide tables. Overly wide text generates <quote>Overfull
688-
hbox</quote> messages in the TeX log output file, e.g.
688+
hbox</quote> messages in the TeX log output file, e.g.,
689689
<filename>postgres-US.log</> or <filename>postgres-A4.log</>.
690690
There are 72 points in an inch so anything reported as over 72
691691
points too wide will probably not fit on the printed page (assuming
692692
one inch margins). To find the <acronym>SGML</acronym> text
693693
causing the overflow, find the first page number mentioned above
694-
the overflow message, e.g. <literal>[50 ###]</> (page 50), and
695-
look at the page after that (e.g. page 51) in the <acronym>PDF</acronym>
694+
the overflow message, e.g., <literal>[50 ###]</> (page 50), and
695+
look at the page after that (e.g., page 51) in the <acronym>PDF</acronym>
696696
file to see the overflow text and adjust the <acronym>SGML</acronym>
697697
accordingly.
698698
</para>

‎doc/src/sgml/ecpg.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3627,7 +3627,7 @@ EXEC SQL DEALLOCATE DESCRIPTOR <replaceable>identifier</replaceable>;
36273627
EXEC SQL FETCH NEXT FROM mycursor INTO SQL DESCRIPTOR mydesc;
36283628
</programlisting>
36293629
If the result set is empty, the Descriptor Area will still contain
3630-
the metadata from the query, i.e. the field names.
3630+
the metadata from the query, i.e., the field names.
36313631
</para>
36323632

36333633
<para>
@@ -4044,7 +4044,7 @@ typedef struct sqlvar_struct sqlvar_t;
40444044
<term><literal>sqllen</></term>
40454045
<listitem>
40464046
<para>
4047-
Contains the binary length of the field. e.g. 4 bytes for <type>ECPGt_int</type>.
4047+
Contains the binary length of the field. e.g., 4 bytes for <type>ECPGt_int</type>.
40484048
</para>
40494049
</listitem>
40504050
</varlistentry>
@@ -7971,7 +7971,7 @@ EXEC SQL CLOSE DATABASE;
79717971
<term><literal>FREE cursor_name</></term>
79727972
<listitem>
79737973
<para>
7974-
Due to the differences how ECPG works compared to Informix's ESQL/C (i.e. which steps
7974+
Due to the differences how ECPG works compared to Informix's ESQL/C (i.e., which steps
79757975
are purely grammar transformations and which steps rely on the underlying run-time library)
79767976
there is no <literal>FREE cursor_name</> statement in ECPG. This is because in ECPG,
79777977
<literal>DECLARE CURSOR</literal> doesn't translate to a function call into

‎doc/src/sgml/extend.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@
508508
<para>
509509
An extension is <firstterm>relocatable</> if it is possible to move
510510
its contained objects into a different schema after initial creation
511-
of the extension. The default is <literal>false</>, i.e. the
511+
of the extension. The default is <literal>false</>, i.e., the
512512
extension is not relocatable.
513513
See below for more information.
514514
</para>

‎doc/src/sgml/func.sgml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5909,7 +5909,7 @@ SELECT regexp_matches('abc01234xyz', '(?:(.*?)(\d+)(.*)){1,1}');
59095909
will be replaced by the year data, but the single <literal>Y</literal> in <literal>Year</literal>
59105910
will not be. In <function>to_date</>, <function>to_number</>,
59115911
and <function>to_timestamp</>, double-quoted strings skip the number of
5912-
input characters contained in the string, e.g. <literal>"XX"</>
5912+
input characters contained in the string, e.g., <literal>"XX"</>
59135913
skips two input characters.
59145914
</para>
59155915
</listitem>
@@ -5924,9 +5924,9 @@ SELECT regexp_matches('abc01234xyz', '(?:(.*?)(\d+)(.*)){1,1}');
59245924

59255925
<listitem>
59265926
<para>
5927-
If the year format specification is less than four digits, e.g.
5927+
If the year format specification is less than four digits, e.g.,
59285928
<literal>YYY</>, and the supplied year is less than four digits,
5929-
the year will be adjusted to be nearest to the year 2020, e.g.
5929+
the year will be adjusted to be nearest to the year 2020, e.g.,
59305930
<literal>95</> becomes 1995.
59315931
</para>
59325932
</listitem>
@@ -6039,7 +6039,7 @@ SELECT regexp_matches('abc01234xyz', '(?:(.*?)(\d+)(.*)){1,1}');
60396039
<listitem>
60406040
<para>
60416041
<function>to_char(interval)</function> formats <literal>HH</> and
6042-
<literal>HH12</> as shown on a 12-hour clock, i.e. zero hours
6042+
<literal>HH12</> as shown on a 12-hour clock, i.e., zero hours
60436043
and 36 hours output as <literal>12</>, while <literal>HH24</>
60446044
outputs the full hour value, which can exceed 23 for intervals.
60456045
</para>
@@ -18640,7 +18640,7 @@ FOR EACH ROW EXECUTE PROCEDURE suppress_redundant_updates_trigger();
1864018640
<row>
1864118641
<entry><literal>objsubid</literal></entry>
1864218642
<entry><type>integer</type></entry>
18643-
<entry>Sub-object ID (e.g. attribute number for a column)</entry>
18643+
<entry>Sub-object ID (e.g., attribute number for a column)</entry>
1864418644
</row>
1864518645
<row>
1864618646
<entry><literal>command_tag</literal></entry>
@@ -18727,7 +18727,7 @@ FOR EACH ROW EXECUTE PROCEDURE suppress_redundant_updates_trigger();
1872718727
<row>
1872818728
<entry><literal>objsubid</literal></entry>
1872918729
<entry><type>integer</type></entry>
18730-
<entry>Sub-object ID (e.g. attribute number for a column)</entry>
18730+
<entry>Sub-object ID (e.g., attribute number for a column)</entry>
1873118731
</row>
1873218732
<row>
1873318733
<entry><literal>original</literal></entry>

‎doc/src/sgml/gin.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -630,7 +630,7 @@
630630
contains the corresponding query keys. Likewise, the function must
631631
return GIN_FALSE only if the item does not match, whether or not it
632632
contains the GIN_MAYBE keys. If the result depends on the GIN_MAYBE
633-
entries, i.e. the match cannot be confirmed or refuted based on the
633+
entries, i.e., the match cannot be confirmed or refuted based on the
634634
known query keys, the function must return GIN_MAYBE.
635635
</para>
636636
<para>

‎doc/src/sgml/high-availability.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ protocol to make nodes agree on a serializable transactional order.
201201
this is unacceptable, either the middleware or the application
202202
must query such values from a single server and then use those
203203
values in write queries. Another option is to use this replication
204-
option with a traditional master-standby setup, i.e. data modification
204+
option with a traditional master-standby setup, i.e., data modification
205205
queries are sent only to the master and are propagated to the
206206
standby servers via master-standby replication, not by the replication
207207
middleware. Care must also be taken that all
@@ -628,7 +628,7 @@ protocol to make nodes agree on a serializable transactional order.
628628
Set up continuous archiving on the primary to an archive directory
629629
accessible from the standby, as described
630630
in <xref linkend="continuous-archiving">. The archive location should be
631-
accessible from the standby even when the master is down, i.e. it should
631+
accessible from the standby even when the master is down, i.e., it should
632632
reside on the standby server itself or another trusted server, not on
633633
the master server.
634634
</para>
@@ -2078,7 +2078,7 @@ LOG: database system is ready to accept read only connections
20782078
<itemizedlist>
20792079
<listitem>
20802080
<para>
2081-
Data Definition Language (DDL) - e.g. <command>CREATE INDEX</>
2081+
Data Definition Language (DDL) - e.g., <command>CREATE INDEX</>
20822082
</para>
20832083
</listitem>
20842084
<listitem>
@@ -2144,7 +2144,7 @@ LOG: database system is ready to accept read only connections
21442144

21452145
<para>
21462146
WAL file control commands will not work during recovery,
2147-
e.g. <function>pg_start_backup</>, <function>pg_switch_xlog</> etc.
2147+
e.g., <function>pg_start_backup</>, <function>pg_switch_xlog</> etc.
21482148
</para>
21492149

21502150
<para>

0 commit comments

Comments
 (0)