]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Docs: align sqlite3 docs with versionadded/versionchanged recommendations (#114400)
authorErlend E. Aasland <erlend@python.org>
Sun, 21 Jan 2024 19:54:19 +0000 (20:54 +0100)
committerGitHub <noreply@github.com>
Sun, 21 Jan 2024 19:54:19 +0000 (19:54 +0000)
When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.

Doc/library/sqlite3.rst

index 6dbb34a84a4c406425528dc6e937349e190b84be..c3406b166c3d89d6bd254e04e4799afc6fbc2217 100644 (file)
@@ -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.
 
    .. versionchanged:: 3.13
       Positional use of the parameters *timeout*, *detect_types*,
@@ -747,8 +747,8 @@ Connection objects
           `deterministic <https://sqlite.org/deterministic.html>`_,
           which allows SQLite to perform additional optimizations.
 
-      .. versionadded:: 3.8
-         The *deterministic* parameter.
+      .. versionchanged:: 3.8
+         Added the *deterministic* parameter.
 
       Example:
 
@@ -1132,8 +1132,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_
 
@@ -1762,10 +1762,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) <len>` to get the size (number of bytes) of the blob.