Skip to content

Doc: Correct sqlite3 API descriptions and SQL examples - #162193

Open
methane wants to merge 1 commit into
python:mainfrom
methane:fix-doc-sqlite3
Open

methane wants to merge 1 commit into
python:mainfrom
methane:fix-doc-sqlite3

Conversation

@methane

@methane methane commented Nov 18, 2026

Copy link
Copy Markdown
Member
  • Use -- for SQL comments so both examples can be executed as written.
  • Explain that expressions such as MAX(p) have no declared type and use the default type conversions.
  • Correct the window function callbacks whose argument count is set by num_params: step() and inverse().
  • Clarify that backup() uses sleep when retrying a busy or locked database.
  • Remove the claim that an active transaction implies uncommitted changes; BEGIN alone sets in_transaction.
  • Restore the wording that identifies PrepareProtocol itself as the argument to __conform__().
  • Clarify that entering the connection context manager does not open a transaction. With autocommit=False, a new transaction opens after commit or rollback on exit.
  • Clarify that URI mode rw requires an existing database file and raises OperationalError if the file is missing.

@methane methane added the docs Documentation in the Doc dir label Nov 18, 2026
@methane methane added skip issue skip news needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Nov 18, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Nov 18, 2026
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35973975 | 📁 Comparing de11f11 against main (9427640)

  🔍 Preview build  

1 file changed
± library/sqlite3.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting core review docs Documentation in the Doc dir needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes skip issue skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant