Opened 11 years ago
Closed 11 years ago
#22590 closed Cleanup/optimization (worksforme)
Default Timezone Documentation Directly Contradicts Self
Reported by: | anonymous | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | 1.6 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
See this page:
https://docs.djangoproject.com/en/1.6/topics/i18n/timezones/
Paragraph 4 starts with:
"Time zone support is disabled by default. To enable it, set USE_TZ = True in your settings file."
This directly contradicts the final paragraph of the answer to the first setup question, which says:
"For these reasons, time zone support is enabled by default in new projects, and you should keep it unless you have a very good reason not to."
Checking a default settings.py file generated by Django 1.6.4, it looks like paragraph 4 is incorrect and that time zone support is enabled by default, as stated in the FAQ section.
In fact, both are true, for different levels of "default."
If you do not have a
USE_TZ
setting in your settings file at all, timezone support is disabled by default. (You can test this by removing theUSE_TZ
setting from your settings file, and you will see thatdjango.conf.settings.USE_TZ is False
.)But it is also true that the default new-project template includes
USE_TZ = True
in the settings file, which means that for new projects, timezone support is enabled "by default."Closing this as worksforme, since the documentation is correct as worded. It might be possible to improve the wording to clarify, but I don't think it's worth keeping a ticket open for that in the absence of a specific suggestion. If you have a specific wording suggestion, attach it here as a patch (or submit a pull request) and we can reopen to evaluate whether it is an improvement.
Thanks!