pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedIs it typo of connection_name?
4+ messages / 3 participants
[nested] [flat]
Commits from this thread:
2019-09-19 bec847d9e9 ae2d826922 3153328fa9 d84db2d3a0 4a3d570811 14936be9d1 27b4121311 Doc: Fix incorrect mention to connection_object in CONNECT command of ECPG
* Is it typo of connection_name?
@ 2019-09-17 08:39 PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 4+ messages in thread
From: PG Doc comments form @ 2019-09-17 08:39 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: egashira.yusuke@jp.fujitsu.com
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/11/ecpg-sql-connect.html
Description:
The "connection_name" parameter's explanation is not in Parameters
section.
Instead of it, "connection_object" parameter is in Parameters section. Its
explanation seems about "connection_name".
Is it typo about "connection_name" in Synopsis section, or
"connection_object" in Parameters section?
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Is it typo of connection_name?
@ 2019-09-18 01:49 Michael Paquier <michael@paquier.xyz>
parent: PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 4+ messages in thread
From: Michael Paquier @ 2019-09-18 01:49 UTC (permalink / raw)
To: egashira.yusuke@jp.fujitsu.com; pgsql-docs@lists.postgresql.org
On Tue, Sep 17, 2019 at 08:39:27AM +0000, PG Doc comments form wrote:
> The "connection_name" parameter's explanation is not in Parameters
> section.
> Instead of it, "connection_object" parameter is in Parameters section. Its
> explanation seems about "connection_name".
> Is it typo about "connection_name" in Synopsis section, or
> "connection_object" in Parameters section?
Good catch. If you look at the code (ecpg.trailer), connection_object
refers to the name of the parameter, while connection_name refers to
"AS connection_object" as a whole. So it seems to me that the
intention is to use connection_object in the synopsis of the docs.
Any thoughts from others?
--
Michael
Attachments:
signature.asc (application/pgp-signature, 832B) download
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Is it typo of connection_name?
@ 2019-09-19 04:20 Michael Paquier <michael@paquier.xyz>
parent: Michael Paquier <michael@paquier.xyz>
0 siblings, 1 reply; 4+ messages in thread
From: Michael Paquier @ 2019-09-19 04:20 UTC (permalink / raw)
To: egashira.yusuke@jp.fujitsu.com; pgsql-docs@lists.postgresql.org
On Wed, Sep 18, 2019 at 10:49:14AM +0900, Michael Paquier wrote:
> Good catch. If you look at the code (ecpg.trailer), connection_object
> refers to the name of the parameter, while connection_name refers to
> "AS connection_object" as a whole. So it seems to me that the
> intention is to use connection_object in the synopsis of the docs.
> Any thoughts from others?
Actually, looking around we use connection_name for other commands
like EXEC SQL or DISCONNECT, so renaming connection_object to
connection_name makes the documentation more consistent. And done.
--
Michael
Attachments:
signature.asc (application/pgp-signature, 832B) download
^ permalink raw reply [nested|flat] 4+ messages in thread
* RE: Is it typo of connection_name?
@ 2019-09-19 09:19 Egashira, Yusuke <egashira.yusuke@jp.fujitsu.com>
parent: Michael Paquier <michael@paquier.xyz>
0 siblings, 0 replies; 4+ messages in thread
From: Egashira, Yusuke @ 2019-09-19 09:19 UTC (permalink / raw)
To: Michael Paquier <michael@paquier.xyz>; pgsql-docs@lists.postgresql.org <pgsql-docs@lists.postgresql.org>
Hi Michael
> Actually, looking around we use connection_name for other commands
> like EXEC SQL or DISCONNECT, so renaming connection_object to
> connection_name makes the documentation more consistent. And done.
Thank you for commiting!
Regards.
Yusuke Egashira
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2019-09-19 09:19 UTC | newest]
Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2019-09-17 08:39 Is it typo of connection_name? PG Doc comments form <noreply@postgresql.org>
2019-09-18 01:49 ` Michael Paquier <michael@paquier.xyz>
2019-09-19 04:20 ` Michael Paquier <michael@paquier.xyz>
2019-09-19 09:19 ` Egashira, Yusuke <egashira.yusuke@jp.fujitsu.com>
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