Opened 7 years ago

Closed 7 years ago

#10137 closed (invalid)

windows documentation suggestion

Reported by: emdog4 Owned by: nobody
Component: Documentation Version: 1.0
Severity: Keywords: windows sqlite3
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:


when configuring for the first time, the documentation never specifies that for the DATABASE_NAME: you need to specify your own name (for sqlite3). the doc says to specify DATABASE_ENGINE: 'sqlite3' but not the NAME. i think this should be explained explicitly. it will then create a your_file_name.db file in your project folder.

Change History (1)

comment:1 Changed 7 years ago by kmtracey

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to invalid
  • Status changed from new to closed

It would help if you identified what doc you are talking about. (Also, the title mentions "windows" but I don't understand how there is anything Windows-specific about this -- you need to specify the database file name when using sqlite on all platforms, not just Windows.)

The most natural place for a first-time user to encounter setting up a database is, I think, the tutorial. The tutorial doc for this is here:

and it seems pretty clear that you have to specify a name.

If you bypass the tutorial and go to the doc on settings directly, this is the doc:

which, again, clearly states this is the name of the database file in the case of sqlite.

If you bypass reading the doc entirely and just go by the settings template created by startproject:

DATABASE_NAME = ''             # Or path to database file if using sqlite3.

The comment mentions this is the database file when using sqlite, so it seems clear to me it is something you will need to set to a value if using sqlite3.

If you still think the doc is unclear here, feel free to reopen with a pointer to exactly where you see information missing. It'll have a better chance of geting incorporated if you also provide a patch that shows how you think things could be made clearer.

Note: See TracTickets for help on using tickets.
Back to Top