]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-90923: Improve sqlite3.Connection.execute* docs (GH-91643)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 17 Apr 2022 21:36:32 +0000 (14:36 -0700)
committerGitHub <noreply@github.com>
Sun, 17 Apr 2022 21:36:32 +0000 (14:36 -0700)
- 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@innova.no>
Doc/library/sqlite3.rst

index 9e6950652ebc2c0be8424340f6d249a672301064..d4ba3e2627d8d671b907d6fbcfa683c43be6df75 100644 (file)
@@ -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)