pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Incorrect grammar
2+ messages / 2 participants
[nested] [flat]

* Incorrect grammar
@ 2026-07-18 00:13 PG Doc comments form <noreply@postgresql.org>
  2026-07-19 19:49 ` Re: Incorrect grammar Laurenz Albe <laurenz.albe@cybertec.at>
  0 siblings, 1 reply; 2+ messages in thread

From: PG Doc comments form @ 2026-07-18 00:13 UTC (permalink / raw)
  To: pgsql-docs@lists.postgresql.org; +Cc: william.r.pursell@gmail.com

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/18/tutorial-arch.html
Description:

The collection of words "The user's client (frontend) application that wants
to perform database operations." is not a complete sentence.  (This is from
https://www.postgresql.org/docs/current/tutorial-arch.html). Perhaps you
want to say "A client process is an application that wants to perform
database operations" or similar.







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

* Re: Incorrect grammar
  2026-07-18 00:13 Incorrect grammar PG Doc comments form <noreply@postgresql.org>
@ 2026-07-19 19:49 ` Laurenz Albe <laurenz.albe@cybertec.at>
  0 siblings, 0 replies; 2+ messages in thread

From: Laurenz Albe @ 2026-07-19 19:49 UTC (permalink / raw)
  To: william.r.pursell@gmail.com; pgsql-docs@lists.postgresql.org

On Sat, 2026-07-18 at 00:13 +0000, PG Doc comments form wrote:
> The collection of words "The user's client (frontend) application that wants
> to perform database operations." is not a complete sentence.  (This is from
> https://www.postgresql.org/docs/current/tutorial-arch.html). Perhaps you
> want to say "A client process is an application that wants to perform
> database operations" or similar.

It makes sense if you look at the sentence before the enumeration:

  A PostgreSQL session consists of the following cooperating processes (programs):

  - A server process, which [...]. The database server program is called postgres.

  - The user's client (frontend) application that wants to perform database operations.

Perhaps the source of the problem is that the fragment starts with a capitalized
word and ends with a period.  But since there are sentences following the fragment,
I am not sure how the correct punctuation would be.

Perhaps the fragments could be turned into whole sentences, like

  Second, there is the user's client (frontend) application that wants to perform
  database operations.

Would the attached patch improve the situation for you?

Yours,
Laurenz Albe

Attachments:

  [text/x-patch] v1-0001-Use-whole-sentences-in-the-tutorial.patch (1.6K, ../../11c77608b0d5fa9164920430d2ffc7c06e772de4.camel@cybertec.at/2-v1-0001-Use-whole-sentences-in-the-tutorial.patch)
  download | inline diff:
From f055864aa80ba6ba78df859ad7a7208b091a3e6a Mon Sep 17 00:00:00 2001
From: Laurenz Albe <laurenz.albe@cybertec.at>
Date: Sun, 19 Jul 2026 21:47:07 +0200
Subject: [PATCH v1] Use whole sentences in the tutorial

In an enumeration in the tutorial, the individual items start with
sentence fragments that end with a period.  This confused at least one
reader, so let's use whole sentences in this place.

Report: William R. Pursell <william.r.pursell@gmail.com>
Author: Laurenz Albe <laurenz.albe@cybertec.at>
Discussion: https://postgr.es/m/178433358027.824456.16086075130836422432%40wrigleys.postgresql.org
---
 doc/src/sgml/start.sgml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/src/sgml/start.sgml b/doc/src/sgml/start.sgml
index 0263a700591..23935a0649e 100644
--- a/doc/src/sgml/start.sgml
+++ b/doc/src/sgml/start.sgml
@@ -72,7 +72,7 @@
     <itemizedlist>
      <listitem>
       <para>
-       A server process, which manages the database files, accepts
+       First, there is a server process, which manages the database files, accepts
        connections to the database from client applications, and
        performs database actions on behalf of the clients.  The
        database server program is called
@@ -83,7 +83,7 @@
 
      <listitem>
       <para>
-       The user's client (frontend) application that wants to perform
+       Second, there is the user's client (frontend) application that wants to perform
        database operations.  Client applications can be very diverse
        in nature:  a client could be a text-oriented tool, a graphical
        application, a web server that accesses the database to
-- 
2.55.0



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


end of thread, other threads:[~2026-07-19 19:49 UTC | newest]

Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2026-07-18 00:13 Incorrect grammar PG Doc comments form <noreply@postgresql.org>
2026-07-19 19:49 ` Laurenz Albe <laurenz.albe@cybertec.at>

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