[Python-checkins] gh-90923: Improve sqlite3.Connection.execute* docs (GH-91643)
miss-islington
webhook-mailer at python.org
Sun Apr 17 17:36:36 EDT 2022
https://github.com/python/cpython/commit/833ff16430644a7dacafb061b8a5509818c8b0f7
commit: 833ff16430644a7dacafb061b8a5509818c8b0f7
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-04-17T14:36:32-07:00
summary:
gh-90923: Improve sqlite3.Connection.execute* docs (GH-91643)
- Drop 'nonstandard'; it does not add any value
- Try to be more concise
- Make return value a little more explicit
(cherry picked from commit 017f07a229a337e9c17bed8cd1879e0177a8d89d)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland at innova.no>
files:
M Doc/library/sqlite3.rst
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 9e6950652ebc2..d4ba3e2627d8d 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -373,24 +373,21 @@ Connection Objects
.. method:: execute(sql[, parameters])
- This is a nonstandard shortcut that creates a cursor object by calling
- the :meth:`~Connection.cursor` method, calls the cursor's
- :meth:`~Cursor.execute` method with the *parameters* given, and returns
- the cursor.
+ Create a new :class:`Cursor` object and call
+ :meth:`~Cursor.execute` on it with the given *sql* and *parameters*.
+ Return the new cursor object.
.. method:: executemany(sql[, parameters])
- This is a nonstandard shortcut that creates a cursor object by
- calling the :meth:`~Connection.cursor` method, calls the cursor's
- :meth:`~Cursor.executemany` method with the *parameters* given, and
- returns the cursor.
+ Create a new :class:`Cursor` object and call
+ :meth:`~Cursor.executemany` on it with the given *sql* and *parameters*.
+ Return the new cursor object.
.. method:: executescript(sql_script)
- This is a nonstandard shortcut that creates a cursor object by
- calling the :meth:`~Connection.cursor` method, calls the cursor's
- :meth:`~Cursor.executescript` method with the given *sql_script*, and
- returns the cursor.
+ Create a new :class:`Cursor` object and call
+ :meth:`~Cursor.executescript` on it with the given *sql_script*.
+ Return the new cursor object.
.. method:: create_function(name, num_params, func, *, deterministic=False)
More information about the Python-checkins
mailing list