pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feeduncommon syntax in datatype.sgml
3+ messages / 2 participants
[nested] [flat]
* uncommon syntax in datatype.sgml
@ 2018-07-16 18:42 Liudmila Mantrova <l.mantrova@postgrespro.ru>
0 siblings, 1 reply; 3+ messages in thread
From: Liudmila Mantrova @ 2018-07-16 18:42 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org
Hi,
I have noticed uncommon English syntax in datatype.sgml, with two full
sentences following a colon in the same paragraph. I was inclined to
convert these sentences into a list, but this markup seems unpopular in
PostgreSQL docs for some reason. Please consider a less invasive patch
(attached) that fixes the issue.
--
Liudmila Mantrova
Technical writer at Postgres Professional: http://www.postgrespro.com
The Russian Postgres Company
Attachments:
syntax-fix-in-datatype.patch (text/x-patch, 509B) download
diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml
index 3d36cca..a708100 100644
--- a/doc/src/sgml/datatype.sgml
+++ b/doc/src/sgml/datatype.sgml
@@ -514,7 +514,7 @@
</para>
<para>
- We use the following terms below: The
+ Note the following terms used below. The
<firstterm>precision</firstterm> of a <type>numeric</type>
is the total count of significant digits in the whole number,
that is, the number of digits to both sides of the decimal point.
* Re: uncommon syntax in datatype.sgml
@ 2018-07-17 10:52 Peter Eisentraut <peter.eisentraut@2ndquadrant.com>
parent: Liudmila Mantrova <l.mantrova@postgrespro.ru>
0 siblings, 1 reply; 3+ messages in thread
From: Peter Eisentraut @ 2018-07-17 10:52 UTC (permalink / raw)
To: Liudmila Mantrova <l.mantrova@postgrespro.ru>; pgsql-docs@lists.postgresql.org
On 16.07.18 20:42, Liudmila Mantrova wrote:
> I have noticed uncommon English syntax in datatype.sgml, with two full
> sentences following a colon in the same paragraph.
I don't understand what's wrong with that.
--
Peter Eisentraut http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: uncommon syntax in datatype.sgml
@ 2018-07-17 13:50 Liudmila Mantrova <l.mantrova@postgrespro.ru>
parent: Peter Eisentraut <peter.eisentraut@2ndquadrant.com>
0 siblings, 0 replies; 3+ messages in thread
From: Liudmila Mantrova @ 2018-07-17 13:50 UTC (permalink / raw)
To: Peter Eisentraut <peter.eisentraut@2ndquadrant.com>; pgsql-docs@lists.postgresql.org
On 07/17/2018 01:52 PM, Peter Eisentraut wrote:
> On 16.07.18 20:42, Liudmila Mantrova wrote:
>> I have noticed uncommon English syntax in datatype.sgml, with two full
>> sentences following a colon in the same paragraph.
> I don't understand what's wrong with that.
>
Hi Peter,
I have brought this up because the backpatch to REL9_6_STABLE and below
has lost the capital letter after the colon (commit 037768cf), so I
think this phrase is likely to confuse others in a similar way.
The current syntax in master is indeed acceptable, e.g. Chicago Manual
of Style says:
"The colon may sometimes be used instead of a period to introduce a
series of related sentences." However, this wording suggests to me that
it's not the most common usage, so it can confuse non-native speakers
(like me).
Alternatively, we could fix the backpatch only. The patch based on
REL9_6_STABLE is attached if you decide to choose this path.
--
Liudmila Mantrova
Technical writer at Postgres Professional: http://www.postgrespro.com
The Russian Postgres Company
Attachments:
syntax-fix-in-datatype-9-6.patch (text/x-patch, 506B) download
diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml
index 5f45db2..7244449 100644
--- a/doc/src/sgml/datatype.sgml
+++ b/doc/src/sgml/datatype.sgml
@@ -508,7 +508,7 @@
</para>
<para>
- We use the following terms below: the
+ We use the following terms below: The
<firstterm>precision</firstterm> of a <type>numeric</type>
is the total count of significant digits in the whole number,
that is, the number of digits to both sides of the decimal point.
end of thread, other threads:[~2018-07-17 13:50 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2018-07-16 18:42 uncommon syntax in datatype.sgml Liudmila Mantrova <l.mantrova@postgrespro.ru>
2018-07-17 10:52 ` Peter Eisentraut <peter.eisentraut@2ndquadrant.com>
2018-07-17 13:50 ` Liudmila Mantrova <l.mantrova@postgrespro.ru>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox