public inbox for [email protected]  
help / color / mirror / Atom feed
Duplicate paragraph
6+ messages / 4 participants
[nested] [flat]

* Duplicate paragraph
@ 2021-05-25 03:06  PG Doc comments form <[email protected]>
  0 siblings, 1 reply; 6+ messages in thread

From: PG Doc comments form @ 2021-05-25 03:06 UTC (permalink / raw)
  To: [email protected]; +Cc: [email protected]

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/13/sql-syntax-lexical.html
Description:

Greetings

I was going through the documentation of the SQL Language that you have
provided and there is a possible duplicate paragraph that I noticed in
section 4.1 - Lexical Syntax
(https://www.postgresql.org/docs/current/sql-syntax-lexical.html).

In section 4.1.1 (Identifiers and Key Words), there is a paragraph
explaining a variant of quoted identifier that allows Unicode characters.
All content in the paragraph, right up to the end of section 4.1.1, is
almost copied word-by-word in section 4.1.2.3 - String Constants With
Unicode Escapes. 

I wasn't able to judge if this was intentional or not, so I ended up writing
this.


^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: Duplicate paragraph
@ 2021-05-25 04:35  David G. Johnston <[email protected]>
  parent: PG Doc comments form <[email protected]>
  0 siblings, 1 reply; 6+ messages in thread

From: David G. Johnston @ 2021-05-25 04:35 UTC (permalink / raw)
  To: [email protected] <[email protected]>; [email protected] <[email protected]>

On Monday, May 24, 2021, PG Doc comments form <[email protected]>
wrote:

> Right up to the end of section 4.1.1, is
> almost copied word-by-word in section 4.1.2.3 - String Constants With
> Unicode Escapes.
>
>
They are two different things, as evidenced by there being two different
sections with different section headings, that use the same fundamental
writing rules.

David J.


^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: Duplicate paragraph
@ 2021-05-25 13:12  Bruce Momjian <[email protected]>
  parent: David G. Johnston <[email protected]>
  0 siblings, 2 replies; 6+ messages in thread

From: Bruce Momjian @ 2021-05-25 13:12 UTC (permalink / raw)
  To: David G. Johnston <[email protected]>; +Cc: [email protected] <[email protected]>; [email protected] <[email protected]>

On Mon, May 24, 2021 at 09:35:49PM -0700, David G. Johnston wrote:
> On Monday, May 24, 2021, PG Doc comments form <[email protected]> wrote:
> 
>     Right up to the end of section 4.1.1, is
>     almost copied word-by-word in section 4.1.2.3 - String Constants With
>     Unicode Escapes.
> 
> 
> 
> They are two different things, as evidenced by there being two different
> sections with different section headings, that use the same fundamental writing
> rules.

We have gotten reports about this perceived duplication before --- not
sure how we can improve things.

-- 
  Bruce Momjian  <[email protected]>        https://momjian.us
  EDB                                      https://enterprisedb.com

  If only the physical world exists, free will is an illusion.






^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: Duplicate paragraph
@ 2021-05-25 13:47  David G. Johnston <[email protected]>
  parent: Bruce Momjian <[email protected]>
  1 sibling, 0 replies; 6+ messages in thread

From: David G. Johnston @ 2021-05-25 13:47 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; +Cc: [email protected] <[email protected]>; [email protected] <[email protected]>

On Tuesday, May 25, 2021, Bruce Momjian <[email protected]> wrote:

> On Mon, May 24, 2021 at 09:35:49PM -0700, David G. Johnston wrote:
> > On Monday, May 24, 2021, PG Doc comments form <[email protected]>
> wrote:
> >
> >     Right up to the end of section 4.1.1, is
> >     almost copied word-by-word in section 4.1.2.3 - String Constants With
> >     Unicode Escapes.
> >
> >
> >
> > They are two different things, as evidenced by there being two different
> > sections with different section headings, that use the same fundamental
> writing
> > rules.
>
> We have gotten reports about this perceived duplication before --- not
> sure how we can improve things.
>

Two this year but none the previous 4 sound about right?  I’m up to the
challenge of fixing it if avoiding this type of report is the goal.

David J.


^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: Duplicate paragraph
@ 2021-05-25 13:55  Tom Lane <[email protected]>
  parent: Bruce Momjian <[email protected]>
  1 sibling, 1 reply; 6+ messages in thread

From: Tom Lane @ 2021-05-25 13:55 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; +Cc: David G. Johnston <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>

Bruce Momjian <[email protected]> writes:
> On Mon, May 24, 2021 at 09:35:49PM -0700, David G. Johnston wrote:
>> They are two different things, as evidenced by there being two different
>> sections with different section headings, that use the same fundamental writing
>> rules.

> We have gotten reports about this perceived duplication before --- not
> sure how we can improve things.

Yeah, I was just thinking the same.  The rules *are* largely the same,
by design, so the text is necessarily going to be pretty similar.
But merging these sections doesn't sound like an improvement.

One thing we could easily do is not use isomorphic examples in the two
sections.  For example, instead of illustrating how to spell "data" in
both forms, use "name" as the example for the identifier case.

			regards, tom lane





^ permalink  raw  reply  [nested|flat] 6+ messages in thread

* Re: Duplicate paragraph
@ 2021-05-25 14:13  David G. Johnston <[email protected]>
  parent: Tom Lane <[email protected]>
  0 siblings, 0 replies; 6+ messages in thread

From: David G. Johnston @ 2021-05-25 14:13 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; +Cc: Bruce Momjian <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>

On Tuesday, May 25, 2021, Tom Lane <[email protected]> wrote:

> Bruce Momjian <[email protected]> writes:
> > On Mon, May 24, 2021 at 09:35:49PM -0700, David G. Johnston wrote:
> >> They are two different things, as evidenced by there being two different
> >> sections with different section headings, that use the same fundamental
> writing
> >> rules.
>
> > We have gotten reports about this perceived duplication before --- not
> > sure how we can improve things.
>
> Yeah, I was just thinking the same.  The rules *are* largely the same,
> by design, so the text is necessarily going to be pretty similar.
> But merging these sections doesn't sound like an improvement.


Agrreed.


>
> One thing we could easily do is not use isomorphic examples in the two
> sections.  For example, instead of illustrating how to spell "data" in
> both forms, use "name" as the example for the identifier case.
>
>
+1.  This is the kind change I expected to find once I started looking for
specifics.

David J.


^ permalink  raw  reply  [nested|flat] 6+ messages in thread


end of thread, other threads:[~2021-05-25 14:13 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2021-05-25 03:06 Duplicate paragraph PG Doc comments form <[email protected]>
2021-05-25 04:35 ` David G. Johnston <[email protected]>
2021-05-25 13:12   ` Bruce Momjian <[email protected]>
2021-05-25 13:47     ` David G. Johnston <[email protected]>
2021-05-25 13:55     ` Tom Lane <[email protected]>
2021-05-25 14:13       ` David G. Johnston <[email protected]>

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox