Skip to content

Commit b235936

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 e4263c4 commit b235936

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+103
-103
lines changed

‎doc/src/sgml/config.sgml

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

@@ -1047,7 +1047,7 @@ include_dir 'conf.d'
10471047
<para>
10481048
With this parameter enabled, you can still create ordinary global
10491049
users. Simply append <literal>@</literal> when specifying the user
1050-
name in the client, e.g. <literal>joe@</literal>. The <literal>@</literal>
1050+
name in the client, e.g., <literal>joe@</literal>. The <literal>@</literal>
10511051
will be stripped off before the user name is looked up by the
10521052
server.
10531053
</para>
@@ -2975,7 +2975,7 @@ include_dir 'conf.d'
29752975
disabled, but the server continues to accumulate WAL segment files in
29762976
the expectation that a command will soon be provided. Setting
29772977
<varname>archive_command</varname> to a command that does nothing but
2978-
return true, e.g. <literal>/bin/true</literal> (<literal>REM</literal> on
2978+
return true, e.g., <literal>/bin/true</literal> (<literal>REM</literal> on
29792979
Windows), effectively disables
29802980
archiving, but also breaks the chain of WAL files needed for
29812981
archive recovery, so it should only be used in unusual circumstances.
@@ -4017,7 +4017,7 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
40174017
if your data is likely to be completely in cache, such as when
40184018
the database is smaller than the total server memory, decreasing
40194019
random_page_cost can be appropriate. Storage that has a low random
4020-
read cost relative to sequential, e.g. solid-state drives, might
4020+
read cost relative to sequential, e.g., solid-state drives, might
40214021
also be better modeled with a lower value for random_page_cost,
40224022
e.g., <literal>1.1</literal>.
40234023
</para>
@@ -7754,7 +7754,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
77547754
rows that can be locked; that value is unlimited. The default,
77557755
64, has historically proven sufficient, but you might need to
77567756
raise this value if you have queries that touch many different
7757-
tables in a single transaction, e.g. query of a parent table with
7757+
tables in a single transaction, e.g., query of a parent table with
77587758
many children. This parameter can only be set at server start.
77597759
</para>
77607760

@@ -8279,7 +8279,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
82798279
with assertions enabled. That is the case if the
82808280
macro <symbol>USE_ASSERT_CHECKING</symbol> is defined
82818281
when <productname>PostgreSQL</productname> is built (accomplished
8282-
e.g. by the <command>configure</command> option
8282+
e.g., by the <command>configure</command> option
82838283
<option>--enable-cassert</option>). By
82848284
default <productname>PostgreSQL</productname> is built without
82858285
assertions.

‎doc/src/sgml/datatype.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@
507507
very large number of digits. It is especially recommended for
508508
storing monetary amounts and other quantities where exactness is
509509
required. Calculations with <type>numeric</type> values yield exact
510-
results where possible, e.g. addition, subtraction, multiplication.
510+
results where possible, e.g., addition, subtraction, multiplication.
511511
However, calculations on <type>numeric</type> values are very slow
512512
compared to the integer types, or to the floating-point types
513513
described in the next section.
@@ -4923,7 +4923,7 @@ SELECT * FROM pg_attribute
49234923

49244924
<row>
49254925
<entry><type>unknown</type></entry>
4926-
<entry>Identifies a not-yet-resolved type, e.g. of an undecorated
4926+
<entry>Identifies a not-yet-resolved type, e.g., of an undecorated
49274927
string literal.</entry>
49284928
</row>
49294929

‎doc/src/sgml/ddl.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1253,7 +1253,7 @@ ALTER TABLE products ADD COLUMN description text;
12531253
</para>
12541254

12551255
<para>
1256-
However, if the default value is volatile (e.g.
1256+
However, if the default value is volatile (e.g.,
12571257
<function>clock_timestamp()</function>)
12581258
each row will need to be updated with the value calculated at the time
12591259
<command>ALTER TABLE</command> is executed. To avoid a potentially
@@ -1523,7 +1523,7 @@ ALTER TABLE products RENAME TO items;
15231523

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

‎doc/src/sgml/ecpg.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3659,7 +3659,7 @@ EXEC SQL DEALLOCATE DESCRIPTOR <replaceable>identifier</replaceable>;
36593659
EXEC SQL FETCH NEXT FROM mycursor INTO SQL DESCRIPTOR mydesc;
36603660
</programlisting>
36613661
If the result set is empty, the Descriptor Area will still contain
3662-
the metadata from the query, i.e. the field names.
3662+
the metadata from the query, i.e., the field names.
36633663
</para>
36643664

36653665
<para>
@@ -4076,7 +4076,7 @@ typedef struct sqlvar_struct sqlvar_t;
40764076
<term><literal>sqllen</literal></term>
40774077
<listitem>
40784078
<para>
4079-
Contains the binary length of the field. e.g. 4 bytes for <type>ECPGt_int</type>.
4079+
Contains the binary length of the field. e.g., 4 bytes for <type>ECPGt_int</type>.
40804080
</para>
40814081
</listitem>
40824082
</varlistentry>
@@ -8014,7 +8014,7 @@ EXEC SQL CLOSE DATABASE;
80148014
<term><literal>FREE cursor_name</literal></term>
80158015
<listitem>
80168016
<para>
8017-
Due to the differences how ECPG works compared to Informix's ESQL/C (i.e. which steps
8017+
Due to the differences how ECPG works compared to Informix's ESQL/C (i.e., which steps
80188018
are purely grammar transformations and which steps rely on the underlying run-time library)
80198019
there is no <literal>FREE cursor_name</literal> statement in ECPG. This is because in ECPG,
80208020
<literal>DECLARE CURSOR</literal> doesn't translate to a function call into

‎doc/src/sgml/extend.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,7 @@
573573
<para>
574574
An extension is <firstterm>relocatable</firstterm> if it is possible to move
575575
its contained objects into a different schema after initial creation
576-
of the extension. The default is <literal>false</literal>, i.e. the
576+
of the extension. The default is <literal>false</literal>, i.e., the
577577
extension is not relocatable.
578578
See <xref linkend="extend-extensions-relocation"/> for more information.
579579
</para>
@@ -1438,7 +1438,7 @@ include $(PGXS)
14381438
<term><varname>NO_INSTALLCHECK</varname></term>
14391439
<listitem>
14401440
<para>
1441-
don't define an <literal>installcheck</literal> target, useful e.g. if tests require special configuration, or don't use <application>pg_regress</application>
1441+
don't define an <literal>installcheck</literal> target, useful e.g., if tests require special configuration, or don't use <application>pg_regress</application>
14421442
</para>
14431443
</listitem>
14441444
</varlistentry>

‎doc/src/sgml/func.sgml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6335,9 +6335,9 @@ SELECT regexp_match('abc01234xyz', '(?:(.*?)(\d+)(.*)){1,1}');
63356335
<listitem>
63366336
<para>
63376337
In <function>to_timestamp</function> and <function>to_date</function>,
6338-
if the year format specification is less than four digits, e.g.
6338+
if the year format specification is less than four digits, e.g.,
63396339
<literal>YYY</literal>, and the supplied year is less than four digits,
6340-
the year will be adjusted to be nearest to the year 2020, e.g.
6340+
the year will be adjusted to be nearest to the year 2020, e.g.,
63416341
<literal>95</literal> becomes 1995.
63426342
</para>
63436343
</listitem>
@@ -9786,7 +9786,7 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
97869786
<literal>"string"</literal> (to include all string values), <literal>"numeric"</literal> (to include all numeric values in the string format),
97879787
<literal>"boolean"</literal> (to include all Boolean values in the string format <literal>"true"</literal>/<literal>"false"</literal>),
97889788
<literal>"key"</literal> (to include all keys) or <literal>"all"</literal> (to include all above). These values
9789-
can be combined together to include, e.g. all string and numeric values.
9789+
can be combined together to include, e.g., all string and numeric values.
97909790
</entry>
97919791
<entry><literal>json_to_tsvector('english', '{"a": "The Fat Rats", "b": 123}'::json, '["string", "numeric"]')</literal></entry>
97929792
<entry><literal>'123':5 'fat':2 'rat':3</literal></entry>
@@ -20796,7 +20796,7 @@ FOR EACH ROW EXECUTE FUNCTION suppress_redundant_updates_trigger();
2079620796
<row>
2079720797
<entry><literal>objsubid</literal></entry>
2079820798
<entry><type>integer</type></entry>
20799-
<entry>Sub-object ID (e.g. attribute number for a column)</entry>
20799+
<entry>Sub-object ID (e.g., attribute number for a column)</entry>
2080020800
</row>
2080120801
<row>
2080220802
<entry><literal>command_tag</literal></entry>
@@ -20883,7 +20883,7 @@ FOR EACH ROW EXECUTE FUNCTION suppress_redundant_updates_trigger();
2088320883
<row>
2088420884
<entry><literal>objsubid</literal></entry>
2088520885
<entry><type>integer</type></entry>
20886-
<entry>Sub-object ID (e.g. attribute number for a column)</entry>
20886+
<entry>Sub-object ID (e.g., attribute number for a column)</entry>
2088720887
</row>
2088820888
<row>
2088920889
<entry><literal>original</literal></entry>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ protocol to make nodes agree on a serializable transactional order.
219219
this is unacceptable, either the middleware or the application
220220
must query such values from a single server and then use those
221221
values in write queries. Another option is to use this replication
222-
option with a traditional master-standby setup, i.e. data modification
222+
option with a traditional master-standby setup, i.e., data modification
223223
queries are sent only to the master and are propagated to the
224224
standby servers via master-standby replication, not by the replication
225225
middleware. Care must also be taken that all
@@ -657,7 +657,7 @@ protocol to make nodes agree on a serializable transactional order.
657657
Set up continuous archiving on the primary to an archive directory
658658
accessible from the standby, as described
659659
in <xref linkend="continuous-archiving"/>. The archive location should be
660-
accessible from the standby even when the master is down, i.e. it should
660+
accessible from the standby even when the master is down, i.e., it should
661661
reside on the standby server itself or another trusted server, not on
662662
the master server.
663663
</para>
@@ -2224,7 +2224,7 @@ LOG: database system is ready to accept read only connections
22242224
<itemizedlist>
22252225
<listitem>
22262226
<para>
2227-
Data Definition Language (DDL) - e.g. <command>CREATE INDEX</command>
2227+
Data Definition Language (DDL) - e.g., <command>CREATE INDEX</command>
22282228
</para>
22292229
</listitem>
22302230
<listitem>
@@ -2290,7 +2290,7 @@ LOG: database system is ready to accept read only connections
22902290

22912291
<para>
22922292
WAL file control commands will not work during recovery,
2293-
e.g. <function>pg_start_backup</function>, <function>pg_switch_wal</function> etc.
2293+
e.g., <function>pg_start_backup</function>, <function>pg_switch_wal</function> etc.
22942294
</para>
22952295

22962296
<para>

‎doc/src/sgml/indexam.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ amcanreturn (Relation indexRelation, int attno);
370370
linkend="indexes-index-only-scans"><firstterm>index-only scans</firstterm></link> on
371371
the given column, by returning the indexed column values for an index entry
372372
in the form of an <structname>IndexTuple</structname>. The attribute number
373-
is 1-based, i.e. the first column's attno is 1. Returns true if supported,
373+
is 1-based, i.e., the first column's attno is 1. Returns true if supported,
374374
else false. If the access method does not support index-only scans at all,
375375
the <structfield>amcanreturn</structfield> field in its <structname>IndexAmRoutine</structname>
376376
struct can be set to NULL.

‎doc/src/sgml/install-windows.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
In the <productname>Microsoft Windows SDK</productname>, start the
109109
<application>CMD shell</application> listed under the SDK on the Start Menu.
110110
In recent SDK versions you can change the targeted CPU architecture, build
111-
type, and target OS by using the <command>setenv</command> command, e.g.
111+
type, and target OS by using the <command>setenv</command> command, e.g.,
112112
<command>setenv /x86 /release /xp</command> to target Windows XP or later
113113
with a 32-bit release build. See <command>/?</command> for other options to
114114
<command>setenv</command>. All commands should be run from the
@@ -241,7 +241,7 @@ $ENV{MSBFLAGS}="/m";
241241
installations <filename>C:\Program Files\GnuWin32</filename>.
242242
Consider installing into <filename>C:\GnuWin32</filename> or use the
243243
NTFS short name path to GnuWin32 in your PATH environment setting
244-
(e.g. <filename>C:\PROGRA~1\GnuWin32</filename>).
244+
(e.g., <filename>C:\PROGRA~1\GnuWin32</filename>).
245245
</para>
246246
</note>
247247

‎doc/src/sgml/libpq.sgml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn);
355355
Conversely, if <function>PQconnectPoll(conn)</function> last returned
356356
<symbol>PGRES_POLLING_WRITING</symbol>, wait until the socket is ready
357357
to write, then call <function>PQconnectPoll(conn)</function> again.
358-
On the first iteration, i.e. if you have yet to call
358+
On the first iteration, i.e., if you have yet to call
359359
<function>PQconnectPoll</function>, behave as if it last returned
360360
<symbol>PGRES_POLLING_WRITING</symbol>. Continue this loop until
361361
<function>PQconnectPoll(conn)</function> returns
@@ -860,7 +860,7 @@ postgresql:///mydb?host=localhost&amp;port=5433
860860

861861
<para>
862862
Percent-encoding may be used to include symbols with special meaning in any
863-
of the <acronym>URI</acronym> parts, e.g. replace <literal>=</literal> with
863+
of the <acronym>URI</acronym> parts, e.g., replace <literal>=</literal> with
864864
<literal>%3D</literal>.
865865

866866
</para>
@@ -919,7 +919,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
919919
<literal>hostaddr</literal>, and <literal>port</literal> options accept a comma-separated
920920
list of values. The same number of elements must be given in each
921921
option that is specified, such
922-
that e.g. the first <literal>hostaddr</literal> corresponds to the first host name,
922+
that e.g., the first <literal>hostaddr</literal> corresponds to the first host name,
923923
the second <literal>hostaddr</literal> corresponds to the second host name, and so
924924
forth. As an exception, if only one <literal>port</literal> is specified, it
925925
applies to all the hosts.
@@ -947,7 +947,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
947947
<para>
948948
If a password file is used, you can have different passwords for
949949
different hosts. All the other connection options are the same for every
950-
host in the list; it is not possible to e.g. specify different
950+
host in the list; it is not possible to e.g., specify different
951951
usernames for different hosts.
952952
</para>
953953
</sect3>
@@ -1123,7 +1123,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
11231123
<listitem>
11241124
<para>
11251125
Maximum wait for connection, in seconds (write as a decimal integer,
1126-
e.g. <literal>10</literal>). Zero, negative, or not specified means
1126+
e.g., <literal>10</literal>). Zero, negative, or not specified means
11271127
wait indefinitely. The minimum allowed timeout is 2 seconds, therefore
11281128
a value of <literal>1</literal> is interpreted as <literal>2</literal>.
11291129
This timeout applies separately to each host name or IP address.
@@ -2231,7 +2231,7 @@ const char *PQsslAttribute(const PGconn *conn, const char *attribute_name);
22312231
<term><literal>cipher</literal></term>
22322232
<listitem>
22332233
<para>
2234-
A short name of the ciphersuite used, e.g.
2234+
A short name of the ciphersuite used, e.g.,
22352235
<literal>"DHE-RSA-DES-CBC3-SHA"</literal>. The names are specific
22362236
to each SSL implementation.
22372237
</para>
@@ -4880,7 +4880,7 @@ int PQflush(PGconn *conn);
48804880
<function>PQflush</function> again. Repeat until
48814881
<function>PQflush</function> returns 0. (It is necessary to check for
48824882
read-ready and drain the input with <function>PQconsumeInput</function>,
4883-
because the server can block trying to send us data, e.g. NOTICE
4883+
because the server can block trying to send us data, e.g., NOTICE
48844884
messages, and won't read our data until we read its.) Once
48854885
<function>PQflush</function> returns 0, wait for the socket to be
48864886
read-ready and then read the response as described above.
@@ -7889,7 +7889,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*)
78897889
For a connection to be known secure, SSL usage must be configured
78907890
on <emphasis>both the client and the server</emphasis> before the connection
78917891
is made. If it is only configured on the server, the client may end up
7892-
sending sensitive information (e.g. passwords) before
7892+
sending sensitive information (e.g., passwords) before
78937893
it knows that the server requires high security. In libpq, secure
78947894
connections can be ensured
78957895
by setting the <literal>sslmode</literal> parameter to <literal>verify-full</literal> or

0 commit comments

Comments
 (0)