Global dict name is listed inconsistently

Started by PG Bug reporting formover 7 years ago4 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/10/static/plpython-sharing.html
Description:

Page https://www.postgresql.org/docs/10/static/plpython-sharing.html says:
"The global dictionary SD is available to store data between function
calls." few lines lower it says: "global data and function arguments from
myfunc are not available to myfunc2. The exception is the data in the GD
dictionary, as mentioned above." Note that the global dictionary is named
"SD" in the first quote and "GD" in the second one.

Please correct either first or second sentence.

Kind regards,

Adam Bielański
Happy PostgreSQL user :)

#2Bruce Momjian
bruce@momjian.us
In reply to: PG Bug reporting form (#1)
Re: Global dict name is listed inconsistently

On Tue, Aug 21, 2018 at 09:17:35AM +0000, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/10/static/plpython-sharing.html
Description:

Page https://www.postgresql.org/docs/10/static/plpython-sharing.html says:
"The global dictionary SD is available to store data between function
calls." few lines lower it says: "global data and function arguments from
myfunc are not available to myfunc2. The exception is the data in the GD
dictionary, as mentioned above." Note that the global dictionary is named
"SD" in the first quote and "GD" in the second one.

Please correct either first or second sentence.

Well, the documentation is correct, but obviously not clear. I have the
attached patch which modifies the documentation and clarifies this
issue. Does it help you?

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +

Attachments:

plpython.difftext/x-diff; charset=us-asciiDownload+4-4
#3Adam
abgans@gmail.com
In reply to: Bruce Momjian (#2)
Re: Global dict name is listed inconsistently

Yes, it does, thank you.

Now it's clear why there are two different names.

Best regards,

Adam Bielański

pt., 24 sie 2018, 20:05 użytkownik Bruce Momjian <bruce@momjian.us> napisał:

Show quoted text

On Tue, Aug 21, 2018 at 09:17:35AM +0000, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/10/static/plpython-sharing.html
Description:

Page https://www.postgresql.org/docs/10/static/plpython-sharing.html

says:

"The global dictionary SD is available to store data between function
calls." few lines lower it says: "global data and function arguments from
myfunc are not available to myfunc2. The exception is the data in the GD
dictionary, as mentioned above." Note that the global dictionary is named
"SD" in the first quote and "GD" in the second one.

Please correct either first or second sentence.

Well, the documentation is correct, but obviously not clear. I have the
attached patch which modifies the documentation and clarifies this
issue. Does it help you?

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +
#4Bruce Momjian
bruce@momjian.us
In reply to: Adam (#3)
Re: Global dict name is listed inconsistently

On Fri, Aug 24, 2018 at 08:43:21PM +0200, Adam wrote:

Yes, it does, thank you.

Now it's clear why there are two different names.�

Patch backpatched through 9.3. Thanks for the report.

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +