#31387: Document BASE_DIR setting
--------------------------------------------+------------------------
Reporter: Eric Baumgartner | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 3.0
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
--------------------------------------------+------------------------
BASE_DIR appears to be an established setting. The default startapp
template defines it.
https://github.com/django/django/blob/master/django/conf/project_template/project_name/settings
.py-tpl
And third-party apps like django_extensions rely on BASE_DIR being set.
However, the main settings documentation page does not mention BASE_DIR at
all.
https://docs.djangoproject.com/en/3.0/ref/settings/
This led to confusion in the following case:
- Working with a legacy project that started around django 0.9.6 and has
never defined BASE_DIR, to no apparent ill effect.
- While using django_extensions, an exception is raised ('Settings' object
has no attribute 'BASE_DIR').
- Think: "Ok, that's fine, just need to define it, it's probably a newer
setting."
- Go to django docs to see the definition of BASE_DIR. Find nothing!
- Now confused. Is BASE_DIR unofficial? Why is django_extensions relying
on a non-standard setting?
It would be nice if BASE_DIR could be added to the settings documentation
to resolve this confusion.
--
Ticket URL: <https://code.djangoproject.com/ticket/31387>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/055.c54a68404134d1d09977afaac19825a9%40djangoproject.com.
