summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>2015-06-02 11:14:22 +0100
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>2015-06-02 11:20:02 +0100
commitc2955fb8fc95afd288af22444be8fa11e4132717 (patch)
tree3ef69a047bbf2459fa7080b9b6520520229f6b35 /doc/src
parent5a21da43ee240d66d5fdefd3476a5329e6d730a9 (diff)
downloadpsycopg2-c2955fb8fc95afd288af22444be8fa11e4132717.tar.gz
Version function/constant docs improved
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/extensions.rst10
-rw-r--r--doc/src/module.rst9
2 files changed, 11 insertions, 8 deletions
diff --git a/doc/src/extensions.rst b/doc/src/extensions.rst
index 3f01066..84e1241 100644
--- a/doc/src/extensions.rst
+++ b/doc/src/extensions.rst
@@ -199,12 +199,14 @@ functionalities defined by the |DBAPI|_.
.. function:: libpq_version()
- Query actual ``libpq`` version loaded.
+ Return the version number of the ``libpq`` dynamic library loaded as an
+ integer, in the same format of `~connection.server_version`.
- This function throws `NotSupportedError` if it was compiled with
- ``libpq < 9.1``.
+ Raise `~psycopg2.NotSupportedError` if the ``psycopg2`` module was
+ compiled with a ``libpq`` version lesser than 9.1 (which can be detected
+ by the `~psycopg2.__libpq_version__` constant).
- .. seealso:: libpq docs for `PQlibVersion()`__
+ .. seealso:: libpq docs for `PQlibVersion()`__.
.. __: http://www.postgresql.org/docs/current/static/libpq-misc.html#LIBPQ-PQLIBVERSION
diff --git a/doc/src/module.rst b/doc/src/module.rst
index bd6bcf4..bd121e9 100644
--- a/doc/src/module.rst
+++ b/doc/src/module.rst
@@ -111,10 +111,11 @@ The module interface respects the standard defined in the |DBAPI|_.
.. data:: __libpq_version__
- Integer contant containing the version of ``libpq`` this `psycopg2`
- module was compiled with. If this value is ``>= 90100`` then you
- may query for the actually loaded version of libpq using
- `~psycopg2.extensions.libpq_version()`.
+ Integer constant reporting the version of the ``libpq`` library this
+ ``psycopg2`` module was compiled with (in the same format of
+ `~connection.server_version`). If this value is lesser than ``90100``
+ then you may query the version of the actually loaded library using the
+ `~psycopg2.extensions.libpq_version()` function.
.. index::