pythongh-95273: Improve sqlite3.complete_statement docs

erlend-aasland · Aug 9, 2022 · 2d3b7f1 · 2d3b7f1
1 parent 70fc964
commit 2d3b7f1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 39 deletions.
diff --git a/Doc/includes/sqlite3/complete_statement.py b/Doc/includes/sqlite3/complete_statement.py
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
@@ -222,14 +222,16 @@ Module functions
 
 .. function:: complete_statement(statement)
 
-   Returns ``True`` if the string *statement* contains one or more complete SQL
-   statements terminated by semicolons. It does not verify that the SQL is
-   syntactically correct, only that there are no unclosed string literals and the
-   statement is terminated by a semicolon.
+   Return ``True`` if the string *statement* appears to contain one or more
+   complete SQL statements terminated by semicolons.
+   No syntactic verification or parsing of any kind is performed.
 
-   This can be used to build a shell for SQLite, as in the following example:
+   This function may be useful during command-line input
+   to determine if the entered text seems to form a complete SQL statement,
+   or if additional input is needed before :meth:`executing <Cursor.execute>`
+   the statement.
 
-   .. literalinclude:: ../includes/sqlite3/complete_statement.py
+   See :source:`Lib/sqlite3/__main__.py` for example use.
 
 .. function:: enable_callback_tracebacks(flag, /)