mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Docs: align sqlite3 docs with versionadded/versionchanged recommendations (#114400)

Browse source 
When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
This commit is contained in:
Erlend E. Aasland 2024-01-21 20:54:19 +01:00 • committed by GitHub
parent de17cf444a
commit 336030161a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
Doc/library/sqlite3.rst
View file

@ -343,17 +343,17 @@ Module functions
.. audit-event:: sqlite3.connect database sqlite3.connect .. audit-event:: sqlite3.connect database sqlite3.connect
.. audit-event:: sqlite3.connect/handle connection_handle sqlite3.connect .. audit-event:: sqlite3.connect/handle connection_handle sqlite3.connect
.. versionadded:: 3.4 .. versionchanged:: 3.4
The *uri* parameter. Added the *uri* parameter.
.. versionchanged:: 3.7 .. versionchanged:: 3.7
*database* can now also be a :term:`path-like object`, not only a string. *database* can now also be a :term:`path-like object`, not only a string.
.. versionadded:: 3.10 .. versionchanged:: 3.10
The ``sqlite3.connect/handle`` auditing event. Added the ``sqlite3.connect/handle`` auditing event.
.. versionadded:: 3.12 .. versionchanged:: 3.12
The *autocommit* parameter. Added the *autocommit* parameter.
.. versionchanged:: 3.13 .. versionchanged:: 3.13
Positional use of the parameters *timeout*, *detect_types*, Positional use of the parameters *timeout*, *detect_types*,
@ -747,8 +747,8 @@ Connection objects
`deterministic <https://sqlite.org/deterministic.html>`_, `deterministic <https://sqlite.org/deterministic.html>`_,
which allows SQLite to perform additional optimizations. which allows SQLite to perform additional optimizations.
.. versionadded:: 3.8 .. versionchanged:: 3.8
The *deterministic* parameter. Added the *deterministic* parameter.
Example: Example:
@ -1132,8 +1132,8 @@ Connection objects
.. versionchanged:: 3.10 .. versionchanged:: 3.10
Added the ``sqlite3.load_extension`` auditing event. Added the ``sqlite3.load_extension`` auditing event.
.. versionadded:: 3.12 .. versionchanged:: 3.12
The *entrypoint* parameter. Added the *entrypoint* parameter.
.. _Loading an Extension: https://www.sqlite.org/loadext.html#loading_an_extension_ .. _Loading an Extension: https://www.sqlite.org/loadext.html#loading_an_extension_
@ -1762,10 +1762,10 @@ Row objects
Blob objects Blob objects
^^^^^^^^^^^^ ^^^^^^^^^^^^
.. versionadded:: 3.11
.. class:: Blob .. class:: Blob
.. versionadded:: 3.11
A :class:`Blob` instance is a :term:`file-like object` A :class:`Blob` instance is a :term:`file-like object`
that can read and write data in an SQLite :abbr:`BLOB (Binary Large 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. Call :func:`len(blob) <len>` to get the size (number of bytes) of the blob.