From: Erlend E. Aasland Date: Sun, 21 Jan 2024 20:04:01 +0000 (+0100) Subject: [3.12] Docs: align sqlite3 docs with versionadded/versionchanged recommendations... X-Git-Tag: v3.12.2~125 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=5183a5dee525916d7dca9ab0b443067be257f86f;p=thirdparty%2FPython%2Fcpython.git [3.12] Docs: align sqlite3 docs with versionadded/versionchanged recommendations (#114400) (#114402) (cherry picked from commit 336030161a6cb8aa5b4f42a08510f4383984703f) When a parameter is added to a function or method, use the 'versionchanged' directive, not 'versionadded'. --- diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index c36c3f042de2..bd45cc880052 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -343,17 +343,17 @@ Module functions .. audit-event:: sqlite3.connect database sqlite3.connect .. audit-event:: sqlite3.connect/handle connection_handle sqlite3.connect - .. versionadded:: 3.4 - The *uri* parameter. + .. versionchanged:: 3.4 + Added the *uri* parameter. .. versionchanged:: 3.7 *database* can now also be a :term:`path-like object`, not only a string. - .. versionadded:: 3.10 - The ``sqlite3.connect/handle`` auditing event. + .. versionchanged:: 3.10 + Added the ``sqlite3.connect/handle`` auditing event. - .. versionadded:: 3.12 - The *autocommit* parameter. + .. versionchanged:: 3.12 + Added the *autocommit* parameter. .. function:: complete_statement(statement) @@ -738,8 +738,8 @@ Connection objects :raises NotSupportedError: If *deterministic* is used with SQLite versions older than 3.8.3. - .. versionadded:: 3.8 - The *deterministic* parameter. + .. versionchanged:: 3.8 + Added the *deterministic* parameter. Example: @@ -1101,8 +1101,8 @@ Connection objects .. versionchanged:: 3.10 Added the ``sqlite3.load_extension`` auditing event. - .. versionadded:: 3.12 - The *entrypoint* parameter. + .. versionchanged:: 3.12 + Added the *entrypoint* parameter. .. _Loading an Extension: https://www.sqlite.org/loadext.html#loading_an_extension_ @@ -1731,10 +1731,10 @@ Row objects Blob objects ^^^^^^^^^^^^ -.. versionadded:: 3.11 - .. class:: Blob + .. versionadded:: 3.11 + A :class:`Blob` instance is a :term:`file-like object` that can read and write data in an SQLite :abbr:`BLOB (Binary Large OBject)`. Call :func:`len(blob) ` to get the size (number of bytes) of the blob.