https://github.com/python/cpython/commit/5183a5dee525916d7dca9ab0b443067be257f86f
commit: 5183a5dee525916d7dca9ab0b443067be257f86f
branch: 3.12
author: Erlend E. Aasland <[email protected]>
committer: erlend-aasland <[email protected]>
date: 2024-01-21T20:04:01Z
summary:
[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'.
files:
M Doc/library/sqlite3.rst
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index c36c3f042de276..bd45cc88005256 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) <len>` to get the size (number of bytes) of the blob.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
