#31387: Document BASE_DIR setting.
----------------------------------+--------------------------------------
Reporter: Eric Baumgartner | Owner: nobody
Type: Uncategorized | Status: closed
Component: Documentation | Version: 3.0
Severity: Normal | Resolution: invalid
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
----------------------------------+--------------------------------------
Comment (by kay):
> `BASE_DIR` is not a setting. It's a constant set and used only by a
default `settings.py` template.
In which case that should be documented.
I was just trying to look up how the Django documentation defines
`BASE_DIR` as I'm working on a project whose settings I need to detangle
and wanted to know what it should be "reset" to or what the recommended
default is.
A [https://docs.djangoproject.com/en/dev/search/?q=base_dir search for
`BASE_DIR` in the docs] only turned up six results, none of which actually
explain where it comes from, how to set it (or ''what to''), if it's a
built-in or something the user has to (ought to, may want to,...) set
themselves or similar.
It's mostly referenced in the context of other settings, making it appear
like its existence is considered a given (rather than, say, a stand-in for
`$SOMETHING`, or a convention).
The [https://docs.djangoproject.com/en/dev/howto/overriding-
templates/#:~:text=BASE_DIR%20/%20%22templates%22%5D%2C first search
result] points to a code example in which the variable is actually set,
though that first occurrence isn't highlighted for some reason, only the
latter is (where it's used to construct `TEMPLATES`' `"DIRS"`), so it may
be missed. The text below the box with the code sample contains another
mention – once more not highlighted – but doesn't go into it either.
The docs should spell out what `BASE_DIR` is, what it's used for,
expectations surrounding it etc. when it's first introduced.
--
Ticket URL: <https://code.djangoproject.com/ticket/31387#comment:2>
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 [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/0107019abb430621-75b0ed48-d4d7-43ce-8701-caab47d055fe-000000%40eu-central-1.amazonses.com.
