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 <[email protected]> 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 +
diff --git a/doc/src/sgml/plpython.sgml b/doc/src/sgml/plpython.sgml
new file mode 100644
index d086ddf..60a5907
*** a/doc/src/sgml/plpython.sgml
--- b/doc/src/sgml/plpython.sgml
*************** SELECT * FROM multiout_simple_setof(3);
*** 768,776 ****
<title>Sharing Data</title>
<para>
The global dictionary <varname>SD</varname> is available to store
! data between function calls. This variable is private static data.
The global dictionary <varname>GD</varname> is public data,
! available to all Python functions within a session. Use with
care.<indexterm><primary>global data</primary>
<secondary>in PL/Python</secondary></indexterm>
</para>
--- 768,776 ----
<title>Sharing Data</title>
<para>
The global dictionary <varname>SD</varname> is available to store
! private data between repeated calls to the same function.
The global dictionary <varname>GD</varname> is public data,
! that is available to all Python functions within a session; use with
care.<indexterm><primary>global data</primary>
<secondary>in PL/Python</secondary></indexterm>
</para>
