Commit Graph

196 Commits

Author SHA1 Message Date
Erlend E. Aasland 4b41b11a63
[3.10] gh-98716: Revert gh-96081: Escape lone stars in sqlite3 docs (GH-98720) (#98737)
(cherry picked from commit 365852a03a)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-10-26 22:19:20 +02:00
Miss Islington (bot) 3c09debaa7
gh-97661: Improve accuracy of sqlite3.Cursor.fetchone docs (GH-97662)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 4b83cd0b22)

Co-authored-by: Jia Junjie <62194633+jiajunjie@users.noreply.github.com>
2022-10-05 01:56:47 -07:00
Jia Junjie 6a41d11657
[3.10] gh-97567: Fixup cached_statements default value in sqlite3.connect docs (#97568)
This docs inconsistency was introduced by the 3.10 backport of gh-94629: gh-94646
2022-09-27 09:25:13 +02:00
Miss Islington (bot) ec08534f95
gh-96810: Clarify for which statements sqlite3 implicitly opens transactions (GH-96832)
(cherry picked from commit 16c33a9676)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-09-15 14:20:25 -07:00
Erlend E. Aasland fbc768ff68
[3.10] gh-96702: Order methods before attrs in sqlite3.Connection docs (GH-96703). (#96789)
(cherry picked from commit 49cceeb5c9)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-09-13 10:47:13 +02:00
Miss Islington (bot) f5a784729c
Docs: alphabetically order sqlite3.Cursor attrs (GH-96565)
(cherry picked from commit 9e55685782)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-09-04 14:41:13 -07:00
Miss Islington (bot) bbcb03e7b0
gh-96168: Improve sqlite3 dict_factory example (GH-96457)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 91f40f3f78)

Co-authored-by: Erlend E. Aasland <erlend.aasland@innova.no>
2022-09-01 14:55:41 -07:00
Erlend E. Aasland 2ecc195498
[3.10] gh-96414: Inline code examples in sqlite3 docs (GH-96442). (#96453)
* [3.10] gh-96414: Inline code examples in sqlite3 docs (GH-96442).
(cherry picked from commit f7e7bf161a)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-31 10:10:55 +02:00
Miss Islington (bot) a0d0a77c1f
Docs: normalise sqlite3 placeholder how-to heading (GH-96413)
(cherry picked from commit 7b01ce7953)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-30 13:56:02 -07:00
Erlend E. Aasland af9fbec27e
[3.10] Docs: normalize SQL style in sqlite3 docs (GH-96403). (#96409)
(cherry picked from commit 6d403e264a)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-30 10:35:21 +02:00
Erlend E. Aasland 928a692320
[3.10] gh-95432: Add doctests for the sqlite3 docs (GH-96225) (#96379)
As a consequence of the added test, this commit also includes
fixes for broken examples.

- Add separate namespace for trace tests bco. module level callback
- Move more backup and cursor examples under separate namespaces.
(cherry picked from commit bf9259776d)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-29 12:29:46 +02:00
Erlend E. Aasland 203b598e51
[3.10] gh-94635: Frame sqlite3 how-to headings as such & move default adapters to reference (GH-96136) (#96227)
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>.
(cherry picked from commit 6bda5b85b5)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-24 09:52:16 +02:00
Miss Islington (bot) e9ede9d2a0
gh-96096: Add undocumented SQLITE_OK/DENY/IGNORE sqlite3 constants (GH-96134)
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit d6259c58cb)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-22 23:58:17 -07:00
Miss Islington (bot) 145d8f0e57
gh-95432: Add doctest for sqlite3 tutorial (GH-96193)
(cherry picked from commit 04c73e5efb)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-22 23:56:39 -07:00
Miss Islington (bot) a836204777
gh-96121: Merge sqlite3.Row examples into sqlite3.Row class doc (GH-96122)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 18b1782192)

Co-authored-by: Erlend E. Aasland <erlend.aasland@innova.no>
2022-08-22 01:10:53 -07:00
Miss Islington (bot) 442674e37e
Docs: Fix markup of module name in sqlite3 docs (GH-96115)
(cherry picked from commit ee9f22d346)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-19 01:25:27 -07:00
Miss Islington (bot) d52834d5f5
Doc: Use consistent markup for example Point class in sqlite3 (GH-96095)
(cherry picked from commit 303ef0913e)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-19 00:49:39 -07:00
Miss Islington (bot) 8a6e651e20
Docs: group sqlite3.Connection attributes and methods (GH-96090)
(cherry picked from commit 1a140af40b)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-19 00:38:21 -07:00
Miss Islington (bot) 5e28ec54ff
gh-94635: Remove sqlite3 doc introduction heading (GH-96089)
(cherry picked from commit ede771cdf9)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-19 00:28:49 -07:00
Erlend E. Aasland eb182fe9eb
[3.10] Docs: Escape lone stars in sqlite3 docs (GH-96081). (#96085)
(cherry picked from commit 91afe66707)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-18 22:27:51 +02:00
Miss Islington (bot) 882dd9fe0d
gh-95271: Rework sqlite3 tutorial (GH-95749)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit c87ea10fc9)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-18 11:44:58 -07:00
Erlend E. Aasland 75299dcab5
[3.10] gh-95273: Improve sqlite3.complete_statement docs (GH-95840) (#95918)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit e6623e7083)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-12 09:37:45 +02:00
Erlend E. Aasland 49e505c4bd
[3.10] gh-95273: Reorganize sqlite3 doc module level funcs and vars (GH-95626) (#95803)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 41c939cb35)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-08 22:08:43 +02:00
Miss Islington (bot) 255f7ded77
gh-94635: Fixup sqlite3 'Introduction' seealso note (GH-95751)
In gh-95269, the seealso note incorrectly ended up in
the 'Tutorial' section.
(cherry picked from commit 56af5a200d)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2022-08-06 14:38:18 -07:00
Erlend Egeberg Aasland c57666586b
[3.10] Docs: sqlite3 docs fixup (GH-95681) (#95684)
- Disable links to the module itself
- Consistent ref markup

(cherry picked from commit 44f1f63ad5)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-05 06:41:09 +02:00
Erlend Egeberg Aasland 54ea127923
[3.10] gh-95271: Extract placeholders howto from sqlite3 tutorial (GH-95522) (#95678)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit b24e8b28a7)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-04 22:53:51 +02:00
Erlend Egeberg Aasland 4a204c1486
[3.10] gh-95273: Improve documented return values and exceptions raised for sqlite3 class methods (GH-95530) (#95674)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 12d92c733c)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-04 22:14:02 +02:00
Miss Islington (bot) f6b1c5e454
Docs: fix two typos in the sqlite3 docs (GH-95661)
- statment => statement
- transaciton => transaction
(cherry picked from commit 962acd4468)

Co-authored-by: ceh <emil@hessman.se>
2022-08-04 11:34:37 -07:00
Erlend Egeberg Aasland ac005ea860
[3.10] gh-95273: Align sqlite3 const doc refs with the devguide recommendations (GH-95525). (#95618)
(cherry picked from commit 4d02572f8c)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-03 23:04:35 +02:00
Erlend Egeberg Aasland 6765a784a7
[3.10] gh-94635: Add Reference, How-to, and Explanation headings to sqlite3 docs (GH-94636) (#95483)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 6c439b978b)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>

* Fix refs
2022-07-31 08:47:53 +02:00
Miss Islington (bot) f14ced6062
gh-95273: Relocate sqlite3 enable load extension note (GH-95430)
(cherry picked from commit d92b19e1b5)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-29 12:36:58 -07:00
Miss Islington (bot) 3417ce3489
gh-95432: Fixup sqlite3 tutorial example (GH-95431)
- the insert statement should have five placeholders, not four
- missing ... in the multiline row list
(cherry picked from commit 2fbee85931)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-29 05:38:08 -07:00
Miss Islington (bot) a41b51d2ea
gh-95273: Improve sqlite3 class descriptions (GH-95379)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit e003b64f40)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-29 03:00:29 -07:00
Miss Islington (bot) 2278dc7442
gh-95273: Condense sqlite3 executescript example (GH-95383) (#95419)
(cherry picked from commit e9c8de669d)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-29 10:44:29 +02:00
Miss Islington (bot) f59a5c5363
gh-95273: Move sqlite3 executemany examples from reference to tutorial (GH-95351)
(cherry picked from commit f0bf7956e6)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-29 00:48:55 -07:00
Miss Islington (bot) dcb6fa8099
Docs: Fix refs & tweak wording in sqlite3 'Using shortcut methods' (#95358)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit ea269b9a38)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-28 12:32:20 +02:00
Erlend Egeberg Aasland 2ef7a72682
[3.10] gh-95273: Normalise sqlite3 reference wording (GH-95274) (#95330)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 2361908a9d)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-27 15:42:59 +02:00
Miss Islington (bot) 7e7a570818
gh-94630: Fixup sqlite3 argument spec docs for connection execute* methods (GH-95319)
(cherry picked from commit 2b37395612)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-27 05:54:14 -07:00
Miss Islington (bot) 321b8bbf0f
gh-94635: Add sqlite3 'Introduction' and 'Tutorial' doc headings (GH-95269)
(cherry picked from commit 2e35a13e46)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-26 22:49:29 -07:00
Erlend Egeberg Aasland a4fd732155
[3.10] gh-95235: Add explicit parameter list to some sqlite3 methods (GH-95240) (#95268)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 5012bedc7c)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-26 10:12:50 +02:00
Miss Islington (bot) 0418d9f2f3
gh-95235: Document undocumented parameters in sqlite3 functions and methods (GH-95236)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit ac6a94c669)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-25 09:55:46 -07:00
Miss Islington (bot) 02f1cac282
gh-81040: Improve sqlite3.Cursor.rowcount docs (GH-94940)
(cherry picked from commit f9b3706df6)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-22 00:41:56 -07:00
Miss Islington (bot) 1cf0305ba5
Docs: fix typo in sqlite3.rst (GH-94798)
Colum -> Column
(cherry picked from commit 9ea72e9d8d)

Co-authored-by: Ikko Ashimine <eltociear@gmail.com>
2022-07-14 14:58:14 -07:00
Erlend Egeberg Aasland 691d26a17f
[3.10] gh-94622: Add more references to the sqlite3 types anchor (GH-94623). (#94679)
(cherry picked from commit e5b841a403)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-08 02:50:12 +02:00
Erlend Egeberg Aasland 797745e749
[3.10] gh-94321: Document sqlite3.PrepareProtocol (GH-94620) (#94671)
(cherry picked from commit fb6dccae34)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-08 01:44:09 +02:00
Erlend Egeberg Aasland 663aa6e7d9
[3.10] gh-94628: Add explicit parameter list to sqlite3.connect docs (GH-94629) (#94646)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 3eb2b9634f)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-07 10:46:29 +02:00
Miss Islington (bot) 7f45ae859a
gh-94630: Update sqlite3 docs with positional-only and keyword-only symbols (GH-94631)
(cherry picked from commit 94988603f3)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-06 16:21:05 -07:00
Miss Islington (bot) 7e3b6affa0
gh-94017: Improve clarity of sqlite3 transaction handling docs (GH-94320)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 760b8cf0c8)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-06 14:07:36 -07:00
Łukasz Langa 6e47020d31
[3.10] Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94558)
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
(cherry picked from commit 3440d197a5)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2022-07-05 14:30:37 +02:00
Erlend Egeberg Aasland deb4d0457f
[3.10] gh-90016: Reword sqlite3 adapter/converter docs (GH-93095) (#94273)
Also add adapters and converter recipes.

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com.
(cherry picked from commit bd3c1c187e)
2022-06-25 22:55:38 +02:00