Skip to content

Improve the sqlite3 tutorial #95271

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

Closed
erlend-aasland opened this issue Jul 26, 2022 · 3 comments · Fixed by #95749 or #95522
Closed

Improve the sqlite3 tutorial #95271

erlend-aasland opened this issue Jul 26, 2022 · 3 comments · Fixed by #95749 or #95522
Assignees
Labels
3.10 only security fixes 3.11 only security fixes 3.12 only security fixes docs Documentation in the Doc dir triaged The issue has been accepted as valid by a triager.

Comments

@erlend-aasland
Copy link
Contributor

erlend-aasland commented Jul 26, 2022

Improve the tutorial using Diataxis as a guideline: https://diataxis.fr/tutorials/

The current tutorial is quite good, but it could make use of some improvements. The first that comes to mind, is:

Suggesting to split this up into multiple PRs, for the reviewers convenience.

@erlend-aasland erlend-aasland self-assigned this Jul 26, 2022
@erlend-aasland erlend-aasland added docs Documentation in the Doc dir triaged The issue has been accepted as valid by a triager. labels Jul 26, 2022
@erlend-aasland erlend-aasland moved this from TODO: Docs to In Progress in sqlite3 issues Jul 26, 2022
@erlend-aasland erlend-aasland moved this from In Progress to TODO: Docs in sqlite3 issues Jul 26, 2022
@erlend-aasland erlend-aasland added 3.11 only security fixes 3.10 only security fixes 3.12 only security fixes labels Jul 26, 2022
@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Jul 27, 2022

cc. @CAM-Gerlach & @ezio-melotti #diataxis

@erlend-aasland
Copy link
Contributor Author

Currently, the tutorial uses two different database examples (one stock exchange example, and a more recent programming language info example). We should aim to use just a single example database for the tutorial. That example database could also be used in other examples, sprinkled across the reference and in how-to's1.

So, I'm not particularly fond of the stock exchange example; it works well, but it is ... maybe a little bit dull2? Would it be more fun for the aspiring Python SQLite database programmer if we expand on the programming languages example? Or perhaps something else?

Quoting Diátaxis, I think this touches upon the first item in this list; the example must be meaningful for the tutorial to be meaningful:

At the same time, the exercise you put your pupils through must be:

meaningful - the pupil needs to have a sense of achievement
successful - the pupil needs to be able to complete it
logical - the path that the pupil takes through it needs to make sense
usefully complete - the pupil must have an encounter with all of the actions, concepts and tools they need to become familiar with

Footnotes

  1. It will probably not make sense to just use one grand example database for the whole sqlite3 docs; e.g., the type detection and the user-defined functions work best with stand-alone examples.

  2. No offence meant to the original author; it's just my personal opinion.

@CAM-Gerlach
Copy link
Member

So, I'm not particularly fond of the stock exchange example; it works well, but it is ... maybe a little bit dull2?

Maybe spice it up with some cryptocurrency? That's bound to be...exciting...these days... /s

As to the example, I'm really not sure. While being a relative subject matter n00b has been helpful in reviewing the docs from a more beginner perspective, I don't really have the required background to suggest something in this specific question, sorry.

erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Aug 1, 2022
@erlend-aasland erlend-aasland moved this from TODO: Docs to In Progress in sqlite3 issues Aug 1, 2022
erlend-aasland added a commit that referenced this issue Aug 4, 2022
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Aug 4, 2022
…al (pythonGH-95522)

Co-authored-by: CAM Gerlach <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
(cherry picked from commit b24e8b2)

Co-authored-by: Erlend Egeberg Aasland <[email protected]>
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Aug 4, 2022
…al (pythonGH-95522)

Co-authored-by: CAM Gerlach <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
(cherry picked from commit b24e8b2)

Co-authored-by: Erlend Egeberg Aasland <[email protected]>
erlend-aasland added a commit that referenced this issue Aug 4, 2022
…-95522) (#95678)

Co-authored-by: CAM Gerlach <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
(cherry picked from commit b24e8b2)

Co-authored-by: Erlend Egeberg Aasland <[email protected]>
erlend-aasland added a commit that referenced this issue Aug 4, 2022
…-95522) (#95677)

Co-authored-by: CAM Gerlach <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
(cherry picked from commit b24e8b2)

Co-authored-by: Erlend Egeberg Aasland <[email protected]>
@erlend-aasland erlend-aasland linked a pull request Aug 6, 2022 that will close this issue
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Aug 6, 2022
iritkatriel pushed a commit to iritkatriel/cpython that referenced this issue Aug 11, 2022
Repository owner moved this from In Progress to Done in sqlite3 issues Aug 18, 2022
erlend-aasland added a commit that referenced this issue Aug 18, 2022
Co-authored-by: C.A.M. Gerlach <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 18, 2022
Co-authored-by: C.A.M. Gerlach <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
(cherry picked from commit c87ea10)

Co-authored-by: Erlend E. Aasland <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 18, 2022
Co-authored-by: C.A.M. Gerlach <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
(cherry picked from commit c87ea10)

Co-authored-by: Erlend E. Aasland <[email protected]>
miss-islington added a commit that referenced this issue Aug 18, 2022
Co-authored-by: C.A.M. Gerlach <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
(cherry picked from commit c87ea10)

Co-authored-by: Erlend E. Aasland <[email protected]>
miss-islington added a commit that referenced this issue Aug 18, 2022
Co-authored-by: C.A.M. Gerlach <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
(cherry picked from commit c87ea10)

Co-authored-by: Erlend E. Aasland <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.10 only security fixes 3.11 only security fixes 3.12 only security fixes docs Documentation in the Doc dir triaged The issue has been accepted as valid by a triager.
Projects
Status: Done
2 participants