Re: Connecting to database step is bypassed

2025-10-25 Thread David G. Johnston
On Sat, Oct 25, 2025 at 9:58 AM PG Doc comments form 
wrote:

> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/18/tutorial-createdb.html
> Description:
>
> Execution of
> $ createdb mydb
> suppose that the user is already logged to database manager in the cli bu
> psql
> In this tutorial they are not describing before how to connect to the
> database using psql or something equivalent
>

If they are already logged into the CLI at this point they haven't followed
the tutorial.  That step is covered in the following section.

David J.


Connecting to database step is bypassed

2025-10-25 Thread PG Doc comments form
The following documentation comment has been logged on the website:

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

Execution of
$ createdb mydb
suppose that the user is already logged to database manager in the cli bu
psql
In this tutorial they are not describing before how to connect to the
database using psql or something equivalent


Re: Documentation improvement patch

2025-10-25 Thread Oleg

Dear Daniel,

Thank you for your prompt feedback.

Attached, please find the updated documentation patch, which 
incorporates your suggestions from both the first and second rounds of 
review.


--
Oleg Sibiryakov

On 22.10.2025 11:02, Daniel Gustafsson wrote:

On 13 Oct 2025, at 12:51, Oleg wrote:
- COPY and other functions which allow executing a
+ the COPY command and functions, which allow executing a
I'm not sure about these, I think we use COPY without the the "the COPY
command" decoration in many places so I think it's more consistent like this.

I actually think we should add the decoration here because "COPY 
and other file-access functions"
sounds a bit confusing since COPY is not a file-access function and we seem to 
put it in the list. Even though I
agree that everybody knows COPY is a command, not a function.

We refer to SQL commands by just their names all over the documentation without
saying "an EXPLAIN command" etc, and I think this falls in that same category.


- to call functions defined in the standard internal library, by using an
+ to call functions defined in the standard internal function library by using 
an
interface similar to their SQL signature.
Isn't it a bit redundant to say "internal function library" when we are already
talking about function definitions?

I agree that it may seem redundant, I added "function" here for the sake of 
consistency with lines 1829/1830 (if applied to the master branch)
where the documentation mentions "standard internal function library".

I hadn't seen that, but with that in mind I agree that being consistent is good
so I'll withdraw that comment.

--
Daniel Gustafsson


diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 0a2a8b49fdb..71c2bbf7615 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -1232,11 +1232,11 @@ include_dir 'conf.d'
oauth_validator_libraries configuration parameter
   
   
   

-The library/libraries to use for validating OAuth connection tokens. If
+Sets the library/libraries to use for validating OAuth connection tokens. If
 only one validator library is provided, it will be used by default for
 any OAuth connections; otherwise, all
 oauth HBA entries
 must explicitly set a validator chosen from this
 list. If set to an empty string (the default), OAuth connections will be
@@ -1398,11 +1398,11 @@ include_dir 'conf.d'
   
   

 Specifies a list of cipher suites that are allowed by connections using
 TLS version 1.3.  Multiple cipher suites can be
-specified by using a colon separated list. If left blank, the default
+specified by using a colon-separated list. If left blank, the default
 set of cipher suites in OpenSSL will be used.

 

 This parameter can only be set in the
@@ -2430,11 +2430,11 @@ include_dir 'conf.d'
max_files_per_process configuration parameter
   
   
   

-Sets the maximum number of open files each server subprocess is
+Sets the maximum number of files each server subprocess is
 allowed to open simultaneously;  files already opened in the
 postmaster are not counted toward this limit. The default is one
 thousand files.


diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml
index 593202f4fb2..fe8d73e1f8c 100644
--- a/doc/src/sgml/installation.sgml
+++ b/doc/src/sgml/installation.sgml
@@ -3168,11 +3168,11 @@ ninja install
   -DPG_TEST_EXTRA=TEST_SUITES
   

 Enable additional test suites, which are not run by default because
 they are not secure to run on a multiuser system, require special
-software to run, or are resource intensive.  The argument is a
+software to run, or are resource-intensive.  The argument is a
 whitespace-separated list of tests to enable. See
  for details. If the
 PG_TEST_EXTRA environment variable is set when the
 tests are run, it overrides this setup-time option.

diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml
index 781a01067f7..9b032fbf675 100644
--- a/doc/src/sgml/postgres-fdw.sgml
+++ b/doc/src/sgml/postgres-fdw.sgml
@@ -1224,11 +1224,11 @@ postgres=# SELECT postgres_fdw_disconnect_all();
   

 PostgresFdwCleanupResult
 
  
-  Waiting for transaction abort on remote server.
+  Waiting for transaction abort on a remote server.
  
 

 

diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml
index af476c82fcc..2101442c90f 100644
--- a/doc/src/sgml/postgres.sgml
+++ b/doc/src/sgml/postgres.sgml
@@ -47,11 +47,11 @@ break is not needed in a wider output rendering.
 important aspects of the PostgreSQL system.
 It makes no attempt to be a comprehensive treatment of the topics it covers.