]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: mention that conn.pipeline() yields a Pipeline object 295/head
authorDenis Laxalde <denis@laxalde.org>
Sat, 7 May 2022 15:49:43 +0000 (17:49 +0200)
committerDenis Laxalde <denis@laxalde.org>
Sat, 7 May 2022 15:51:38 +0000 (17:51 +0200)
While reading the section, it is otherwise not obvious to understand
where to get the Pipeline object from.

docs/advanced/pipeline.rst

index d13f95e0a01e12904e8c1a448c44c0c3f4b7bc5a..ef9b73e346483871e56d585a9cd2c1e10c90daa3 100644 (file)
@@ -48,8 +48,8 @@ Pipeline mode usage
 -------------------
 
 Psycopg supports the pipeline mode via the `Connection.pipeline()` method. The
-method is a context manager: at the end of the ``with`` block, the connection
-resumes the normal operation mode.
+method is a context manager: entering the ``with`` block yields a `Pipeline`
+object, at the end of block, the connection resumes the normal operation mode.
 
 Within the pipeline block, you can use one or more cursors to execute several
 operations, using `~Cursor.execute()` and `~Cursor.executemany()`. Unlike in