Skip to content

Commit 88350cb

Browse files
author
James William Pye
committed
Correct documentation and add a warning to clientparameters.
1 parent 65e0767 commit 88350cb

3 files changed

Lines changed: 14 additions & 2 deletions

File tree

‎postgresql/__init__.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
version_info[3] if version_info[3] != 'final' else ''
3636
)
3737

38+
# Avoid importing these until requested.
3839
_pg_iri = _pg_driver = _pg_param = None
3940
def open(iri = None, prompt_title = None, **kw):
4041
"""
@@ -51,8 +52,8 @@ def open(iri = None, prompt_title = None, **kw):
5152
Connection keywords can also be used with `open`. See the narratives for
5253
more information.
5354
54-
When `prompt_title` is *not* `None`, a password prompt will be issued if
55-
necessary.
55+
The `prompt_title` keyword is ignored. `open` will never prompt for
56+
the password unless it is explicitly instructed to do so.
5657
5758
(Note: "pq" is the name of the protocol used to communicate with PostgreSQL)
5859
"""

‎postgresql/documentation/clientparameters.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Client Parameters
22
*****************
33

4+
.. warning:: **The interfaces dealing with optparse are subject to change in 1.0**.
5+
46
There are various sources of parameters used by PostgreSQL client applications.
57
The `postgresql.clientparameters` module provides a means for collecting and
68
managing those parameters.

‎sphinx-src/modules.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@ Modules
33

44
Modules intended for general use.
55

6+
:mod:`postgresql`
7+
-----------------
8+
9+
.. automodule:: postgresql
10+
.. autodata:: version
11+
.. autodata:: version_info
12+
.. autofunction:: open
13+
14+
615
:mod:`postgresql.string`
716
------------------------
817

0 commit comments

Comments
 (0)