From: Daniele Varrazzo Date: Wed, 25 Aug 2021 11:37:32 +0000 (+0200) Subject: Drop Cursor.pgresult duplication in docs X-Git-Tag: 3.0.beta1~37 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7315d3eb204d33f267fa2d4c1a926e131029fe04;p=thirdparty%2Fpsycopg.git Drop Cursor.pgresult duplication in docs Better style for Connection.pgconn docs. The old version of the cursor attribute was better. --- diff --git a/docs/api/connections.rst b/docs/api/connections.rst index b0da85aba..552f70a78 100644 --- a/docs/api/connections.rst +++ b/docs/api/connections.rst @@ -205,7 +205,8 @@ The `!Connection` class .. rubric:: Checking and configuring the connection state - .. autoattribute:: pgconn + .. attribute:: pgconn + :type: psycopg.pq.PGconn The `~pq.PGconn` libpq connection wrapper underlying the `!Connection`. diff --git a/docs/api/cursors.rst b/docs/api/cursors.rst index bebdd5aaf..8f8465084 100644 --- a/docs/api/cursors.rst +++ b/docs/api/cursors.rst @@ -157,12 +157,16 @@ The `!Cursor` class .. automethod:: fetchall .. automethod:: nextset .. automethod:: scroll + .. attribute:: pgresult :type: Optional[psycopg.pq.PGresult] The result returned by the last query and currently exposed by the cursor, if available, else `!None`. + It can be used to obtain low level info about the last query result + and to access to features not currently wrapped by Psycopg. + .. rubric:: Information about the data @@ -180,13 +184,6 @@ The `!Cursor` class .. autoattribute:: rowcount .. autoattribute:: rownumber - .. attribute:: pgresult - - The `~pq.PGresult` object obtained by the last query. - - It can be used to obtain low level info about the last query result - and to access to features not currently wrapped by Psycopg. - .. attribute:: _query An helper object used to convert queries and parameters before sending