Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Inline sqlite3 code examples #96414

Closed
erlend-aasland opened this issue Aug 30, 2022 · 1 comment
Closed

Docs: Inline sqlite3 code examples #96414

erlend-aasland opened this issue Aug 30, 2022 · 1 comment
Labels
docs Documentation in the Doc dir easy expert-sqlite3 triaged The issue has been accepted as valid by a triager. type-feature A feature request or enhancement

Comments

@erlend-aasland
Copy link
Contributor

erlend-aasland commented Aug 30, 2022

Currently, a lot of the sqlite3 code examples are included into Doc/library/sqlite3.rst using literalincludes. This implies that they are not included in doctests, so making sure they work is a continuous task that needs to be done manually by the maintainer. Also, sqlite3 stands out with this practice; very few other stdlib modules include code examples using literalinclude.

Suggesting to inline all examples, because of the following benefits:

  • make it possible to doctest all examples
  • keep the examples together with the text, instead of fragmenting it over multiple files
@erlend-aasland erlend-aasland added type-feature A feature request or enhancement docs Documentation in the Doc dir easy expert-sqlite3 triaged The issue has been accepted as valid by a triager. labels Aug 30, 2022
@bedevere-bot bedevere-bot mentioned this issue Aug 30, 2022
Merged
erlend-aasland added a commit that referenced this issue Aug 31, 2022
@erlend-aasland
gh-96414: Inline code examples in sqlite3 docs (#96442)
f7e7bf1
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 31, 2022
@erlend-aasland @miss-islington
pythongh-96414: Inline code examples in sqlite3 docs (pythonGH-96442)
5378d86 
(cherry picked from commit f7e7bf1)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
@bedevere-bot bedevere-bot mentioned this issue Aug 31, 2022
Merged
miss-islington added a commit that referenced this issue Aug 31, 2022
@miss-islington @erlend-aasland
gh-96414: Inline code examples in sqlite3 docs (GH-96442)
d4d5e60 
(cherry picked from commit f7e7bf1)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
@bedevere-bot bedevere-bot mentioned this issue Aug 31, 2022
Merged
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Aug 31, 2022
@erlend-aasland
[3.10] pythongh-96414: Inline code examples in sqlite3 docs (pythonGH…
96ac116 
…-96442).

(cherry picked from commit f7e7bf1)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Aug 31, 2022

Resolved with:

erlend-aasland added a commit that referenced this issue Aug 31, 2022
@erlend-aasland
[3.10] gh-96414: Inline code examples in sqlite3 docs (GH-96442). (#9…
2ecc195 
…6453)

* [3.10] gh-96414: Inline code examples in sqlite3 docs (GH-96442).
(cherry picked from commit f7e7bf1)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy expert-sqlite3 triaged The issue has been accepted as valid by a triager. type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@erlend-aasland