Opened 2 years ago

Closed 2 years ago

Last modified 2 years ago

#20069 closed Bug (invalid)

Default value of USE_TZ is unclear/contradictory

Reported by: edavis Owned by: nobody
Component: Documentation Version: 1.5
Severity: Normal Keywords: timezone
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

On https://docs.djangoproject.com/en/1.5/topics/i18n/timezones/, the docs say "Time zone support is disabled by default."

Yet below that is a note saying "The default settings.py file created by django-admin.py startproject includes USE_TZ = True for convenience."

Therefore, it seems like the first line should say "Time zone support is enabled by default" given the default settings.py sets USE_TZ = True.

Change History (2)

comment:1 Changed 2 years ago by aaugustin

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

If you don't put anything in your settings file, time zone support is disabled. Therefore, it's disabled by default. This was required at the time the feature was introduced for backwards compatibility.

However, enabling it provides significantly saner. That's why the settings file created by startproject enables it. It's dubbed the default settings file because you could be using a custom project template.

comment:2 Changed 2 years ago by aaugustin

Specifically, I'm marking as invalid the proposal to change the first line to "Time zone support is enabled by default", because that isn't true.

If you have a better wording for the entire paragraph, please suggest it!

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