Skip to content

Commit 463bef2

Browse files
committed
Misc documentation fixes.
- Misc grammar and punctuation fixes. - Stylistic cleanup: use spaces between function arguments and JSON fields in examples. For example "foo(a,b)" -> "foo(a, b)". Add semicolon after last END in a few PL/pgSQL examples that were missing them. - Make sentence that talked about "..." and ".." operators more clear, by avoiding to end the sentence with "..". That makes it look the same as "..." - Fix syntax description for HAVING: HAVING conditions cannot be repeated Patch by Justin Pryzby, per Yaroslav Schekin's report. Backpatch to all supported versions, to the extent that the patch applies easily. Discussion: https://www.postgresql.org/message-id/20201005191922.GE17626%40telsasoft.com
1 parent d348473 commit 463bef2

16 files changed

+41
-41
lines changed

doc/src/sgml/catalogs.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1318,7 +1318,7 @@
13181318
<entry><type>bool</type></entry>
13191319
<entry>
13201320
Role can log in. That is, this role can be given as the initial
1321-
session authorization identifier
1321+
session authorization identifier.
13221322
</entry>
13231323
</row>
13241324

doc/src/sgml/config.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8436,8 +8436,8 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
84368436
</term>
84378437
<listitem>
84388438
<para>
8439-
If set, do not trace locks for tables below this OID. (use to avoid
8440-
output on system tables)
8439+
If set, do not trace locks for tables below this OID (used to avoid
8440+
output on system tables).
84418441
</para>
84428442
<para>
84438443
This parameter is only available if the <symbol>LOCK_DEBUG</symbol>

doc/src/sgml/dblink.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ SELECT dblink_connect('myconn', 'fdtest');
167167
OK
168168
(1 row)
169169

170-
SELECT * FROM dblink('myconn','SELECT * FROM foo') AS t(a int, b text, c text[]);
170+
SELECT * FROM dblink('myconn', 'SELECT * FROM foo') AS t(a int, b text, c text[]);
171171
a | b | c
172172
----+---+---------------
173173
0 | a | {a0,b0,c0}
@@ -616,7 +616,7 @@ dblink_exec(text sql [, bool fail_on_error]) returns text
616616
<para>
617617
The SQL command that you wish to execute in the remote database,
618618
for example
619-
<literal>insert into foo values(0,'a','{"a0","b0","c0"}')</>.
619+
<literal>insert into foo values(0, 'a', '{"a0","b0","c0"}')</literal>.
620620
</para>
621621
</listitem>
622622
</varlistentry>
@@ -653,7 +653,7 @@ SELECT dblink_connect('dbname=dblink_test_standby');
653653
OK
654654
(1 row)
655655

656-
SELECT dblink_exec('insert into foo values(21,''z'',''{"a0","b0","c0"}'');');
656+
SELECT dblink_exec('insert into foo values(21, ''z'', ''{"a0","b0","c0"}'');');
657657
dblink_exec
658658
-----------------
659659
INSERT 943366 1
@@ -665,7 +665,7 @@ SELECT dblink_connect('myconn', 'dbname=regression');
665665
OK
666666
(1 row)
667667

668-
SELECT dblink_exec('myconn', 'insert into foo values(21,''z'',''{"a0","b0","c0"}'');');
668+
SELECT dblink_exec('myconn', 'insert into foo values(21, ''z'', ''{"a0","b0","c0"}'');');
669669
dblink_exec
670670
------------------
671671
INSERT 6432584 1

doc/src/sgml/func.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20798,7 +20798,7 @@ BEGIN
2079820798
obj.object_name,
2079920799
obj.object_identity;
2080020800
END LOOP;
20801-
END
20801+
END;
2080220802
$$;
2080320803
CREATE EVENT TRIGGER test_event_trigger_for_drops
2080420804
ON sql_drop

doc/src/sgml/gin.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -564,8 +564,8 @@
564564
if a foreground cleanup does occur, it will take even longer.
565565
</para>
566566
<para>
567-
<varname>gin_pending_list_limit</> can be overridden for individual
568-
GIN indexes by changing storage parameters, and which allows each
567+
<varname>gin_pending_list_limit</varname> can be overridden for individual
568+
GIN indexes by changing storage parameters, which allows each
569569
GIN index to have its own cleanup threshold.
570570
For example, it's possible to increase the threshold only for the GIN
571571
index which can be updated heavily, and decrease it otherwise.

doc/src/sgml/high-availability.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1493,7 +1493,7 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
14931493
Note that in this mode, the server will apply WAL one file at a
14941494
time, so if you use the standby server for queries (see Hot Standby),
14951495
there is a delay between an action in the master and when the
1496-
action becomes visible in the standby, corresponding the time it takes
1496+
action becomes visible in the standby, corresponding to the time it takes
14971497
to fill up the WAL file. <varname>archive_timeout</> can be used to make that delay
14981498
shorter. Also note that you can't combine streaming replication with
14991499
this method.

doc/src/sgml/isn.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
hard-coded list of prefixes; this list of prefixes is also used to hyphenate
1515
numbers on output. Since new prefixes are assigned from time to time, the
1616
list of prefixes may be out of date. It is hoped that a future version of
17-
this module will obtained the prefix list from one or more tables that
17+
this module will obtain the prefix list from one or more tables that
1818
can be easily updated by users as needed; however, at present, the
1919
list can only be updated by modifying the source code and recompiling.
2020
Alternatively, prefix validation and hyphenation support may be

doc/src/sgml/mvcc.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1239,7 +1239,7 @@ ERROR: could not serialize access due to read/write dependencies among transact
12391239
<para>
12401240
The <literal>FOR UPDATE</> lock mode
12411241
is also acquired by any <command>DELETE</> on a row, and also by an
1242-
<command>UPDATE</> that modifies the values on certain columns. Currently,
1242+
<command>UPDATE</> that modifies the values of certain columns. Currently,
12431243
the set of columns considered for the <command>UPDATE</> case are those that
12441244
have a unique index on them that can be used in a foreign key (so partial
12451245
indexes and expressional indexes are not considered), but this may change

doc/src/sgml/parallel.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ EXPLAIN SELECT * FROM pgbench_accounts WHERE filler LIKE '%x%';
439439
</para>
440440

441441
<para>
442-
The following operations are always parallel restricted.
442+
The following operations are always parallel restricted:
443443
</para>
444444

445445
<itemizedlist>

doc/src/sgml/plpgsql.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1127,7 +1127,7 @@ BEGIN
11271127
SELECT users.userid INTO STRICT userid
11281128
FROM users WHERE users.username = get_userid.username;
11291129
RETURN userid;
1130-
END
1130+
END;
11311131
$$ LANGUAGE plpgsql;
11321132
</programlisting>
11331133
On failure, this function might produce an error message such as
@@ -1805,7 +1805,7 @@ BEGIN
18051805
RETURN NEXT r; -- return current row of SELECT
18061806
END LOOP;
18071807
RETURN;
1808-
END
1808+
END;
18091809
$BODY$
18101810
LANGUAGE plpgsql;
18111811

@@ -1833,7 +1833,7 @@ BEGIN
18331833
END IF;
18341834

18351835
RETURN;
1836-
END
1836+
END;
18371837
$BODY$
18381838
LANGUAGE plpgsql;
18391839

@@ -4972,7 +4972,7 @@ DECLARE
49724972
f1 int;
49734973
BEGIN
49744974
RETURN f1;
4975-
END
4975+
END;
49764976
$$ LANGUAGE plpgsql;
49774977
WARNING: variable "f1" shadows a previously defined variable
49784978
LINE 3: f1 int;

0 commit comments

Comments
 (0)