[issue45677] [doc] improve sqlite3 docs

Ian Fisher added the comment: I think it would also be helpful to make the examples at the top simpler/more idiomatic, e.g. using a context manager for the connection and calling conn.execute directly instead of spawning a cursor. I think the information about the isolation_level parameter

[issue45677] [doc] improve sqlite3 docs

Carol Willing added the comment: New changeset a40d066e8ef548b52eca2b0e27c219ddd7e11592 by Miss Islington (bot) in branch '3.9': bpo-45677: Reword first section of `sqlite3` docs (GH-29326) (GH-29567) https://github.com/python/cpython/commit/a40d066e8ef548b52eca2b0e27c219ddd7e11592

[issue45677] [doc] improve sqlite3 docs

Carol Willing added the comment: New changeset 94dad5e41e5863e03972f3f3646087fb591f73f9 by Miss Islington (bot) in branch '3.10': bpo-45677: Reword first section of `sqlite3` docs (GH-29326) (GH-29566) https://github.com/python/cpython/commit/94dad5e41e5863e03972f3f3646087fb591f73f9

[issue45677] [doc] improve sqlite3 docs

Change by miss-islington : -- pull_requests: +27815 pull_request: https://github.com/python/cpython/pull/29567 ___ Python tracker ___

[issue45677] [doc] improve sqlite3 docs

Change by miss-islington : -- nosy: +miss-islington nosy_count: 6.0 -> 7.0 pull_requests: +27814 pull_request: https://github.com/python/cpython/pull/29566 ___ Python tracker

[issue45677] [doc] improve sqlite3 docs

Carol Willing added the comment: New changeset 6c5a312fb6d92e879bf4c570b94e18bb9ffe5970 by Erlend Egeberg Aasland in branch 'main': bpo-45677: Reword first section of `sqlite3` docs (#29326) https://github.com/python/cpython/commit/6c5a312fb6d92e879bf4c570b94e18bb9ffe5970 --

[issue45677] [doc] improve sqlite3 docs

Erlend E. Aasland added the comment: See also discussion on Discourse: https://discuss.python.org/t/avoid-addressing-the-user-directly-when-writing-docs/11671 -- ___ Python tracker

[issue45677] [doc] improve sqlite3 docs

Change by Alex Waygood : -- nosy: +AlexWaygood ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue45677] [doc] improve sqlite3 docs

Erlend E. Aasland added the comment: (Nosying Mariatta and Carol from the CPython DWG) -- nosy: +Mariatta, willingc ___ Python tracker ___

[issue45677] [doc] improve sqlite3 docs

Erlend E. Aasland added the comment: > What is wrong with addressing the reader as "you"? I remember this was discussed on python-dev last year (?). IIRC, the majority was in favour of changing the documentation to avoid addressing the reader personally. Let us ask the Documentation

[issue45677] [doc] improve sqlite3 docs

Steven D'Aprano added the comment: What is wrong with addressing the reader as "you"? Avoiding an affirmative tone goes directly against the style-guide you linked to, which recommends an affirmative (positive) tone: "The documentation focuses on affirmatively stating what the language

[issue45677] [doc] improve sqlite3 docs

Change by Erlend E. Aasland : -- keywords: +patch pull_requests: +27595 stage: -> patch review pull_request: https://github.com/python/cpython/pull/29326 ___ Python tracker

[issue45677] [doc] improve sqlite3 docs

New submission from Erlend E. Aasland : The sqlite3 docs could need a little makeover. Here's some things that could be improved: - avoid addressing the reader as "you" - avoid using affirmative tone - establish a "Security Considerations" or "Common Mistakes" section, instead of littering