Skip to content

Commit de11f11

Browse files
committed
Doc: Correct sqlite3 API descriptions and SQL examples
1 parent 7c59816 commit de11f11

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

‎Doc/library/sqlite3.rst‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -443,18 +443,19 @@ Module constants
443443
.. code-block:: sql
444444
445445
CREATE TABLE test(
446-
i integer primary key, ! will look up a converter named "integer"
447-
p point, ! will look up a converter named "point"
448-
n number(10) ! will look up a converter named "number"
446+
i integer primary key, -- will look up a converter named "integer"
447+
p point, -- will look up a converter named "point"
448+
n number(10) -- will look up a converter named "number"
449449
)
450450
451451
This flag may be combined with :const:`PARSE_COLNAMES` using the ``|``
452452
(bitwise or) operator.
453453

454454
.. note::
455455

456-
Generated fields (for example ``MAX(p)``) are returned as :class:`str`.
457-
Use :const:`!PARSE_COLNAMES` to enforce types for such queries.
456+
Expressions such as ``MAX(p)`` have no declared type, so their results use
457+
the :ref:`default type conversions <sqlite3-types>`.
458+
Use :const:`!PARSE_COLNAMES` to specify a converter for such expressions.
458459

459460
.. data:: PARSE_COLNAMES
460461

@@ -467,7 +468,7 @@ Module constants
467468

468469
.. code-block:: sql
469470
470-
SELECT MAX(p) as "p [point]" FROM test; ! will look up converter "point"
471+
SELECT MAX(p) as "p [point]" FROM test; -- will look up converter "point"
471472
472473
This flag may be combined with :const:`PARSE_DECLTYPES` using the ``|``
473474
(bitwise or) operator.
@@ -846,7 +847,7 @@ Connection objects
846847
* ``finalize()``: Return the final result of the aggregate as
847848
:ref:`a type natively supported by SQLite <sqlite3-types>`.
848849

849-
The number of arguments that the ``step()`` and ``value()`` methods
850+
The number of arguments that the ``step()`` and ``inverse()`` methods
850851
must accept is controlled by *num_params*.
851852

852853
Set to ``None`` to remove an existing SQL aggregate window function.
@@ -1186,8 +1187,8 @@ Connection objects
11861187
``ATTACH DATABASE`` SQL statement.
11871188

11881189
:param float sleep:
1189-
The number of seconds to sleep between successive attempts
1190-
to back up remaining pages.
1190+
The number of seconds to wait before retrying a backup step
1191+
when the database is busy or locked.
11911192

11921193
Example 1, copy an existing database into another:
11931194

@@ -1407,8 +1408,7 @@ Connection objects
14071408
This read-only attribute corresponds to the low-level SQLite
14081409
`autocommit mode`_.
14091410

1410-
``True`` if a transaction is active (there are uncommitted changes),
1411-
``False`` otherwise.
1411+
``True`` if a transaction is active, ``False`` otherwise.
14121412

14131413
.. versionadded:: 3.2
14141414

@@ -2172,7 +2172,7 @@ The coordinate pair will be stored as a text string in the database,
21722172
using a semicolon to separate the coordinates.
21732173
This can be implemented by adding a ``__conform__(self, protocol)``
21742174
method which returns the adapted value.
2175-
The object passed to *protocol* will be of type :class:`PrepareProtocol`.
2175+
The parameter *protocol* will be :class:`PrepareProtocol`.
21762176

21772177
.. testcode::
21782178

@@ -2443,7 +2443,7 @@ or if :attr:`~Connection.autocommit` is ``True``,
24432443
the context manager does nothing.
24442444

24452445
.. note::
2446-
The context manager neither implicitly opens a new transaction
2446+
The context manager neither implicitly opens a new transaction on entry
24472447
nor closes the connection. If you need a closing context manager, consider
24482448
using :meth:`contextlib.closing`.
24492449

@@ -2491,8 +2491,8 @@ Some useful URI tricks include:
24912491
OperationalError: attempt to write a readonly database
24922492
>>> con.close()
24932493

2494-
* Do not implicitly create a new database file if it does not already exist;
2495-
will raise :exc:`~sqlite3.OperationalError` if unable to create a new file:
2494+
* Open an existing database in read/write mode.
2495+
If the file does not exist, :func:`connect` raises :exc:`OperationalError`:
24962496

24972497
.. doctest::
24982498

0 commit comments

Comments
 (0)