Repository navigation
Improve the sqlite3 tutorial #95271
Description
Activity
cc. @CAM-Gerlach & @ezio-melotti #diataxis
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 withFootnotes
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.
Reacted by Erlend E. AaslandReacted by Erlend E. Aasland- added 5 commits that reference this issue
on Aug 4, 2022 - linked a pull request that will close this issuegh-95271: Improve sqlite3 tutorial wording #95749
on Aug 6, 2022 - added a commit that references this issue
on Aug 6, 2022 - added a commit that references this issue
on Aug 18, 2022
Metadata
Metadata
Assignees
Labels
Projects
- Status
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.