#36266 closed Cleanup/optimization (fixed)
HIDE_PRODUCTION_WARNING variable name is ambiguous
| Reported by: | Leo | Owned by: | Johanan Oppong Amoateng |
|---|---|---|---|
| Component: | Core (Management commands) | Version: | 5.2 |
| Severity: | Release blocker | Keywords: | |
| Cc: | Andy Miller | Triage Stage: | Ready for checkin |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
Hi - I just saw this feature in the 5.2 release candidate docs, hopefully this isn't too late.
Could the env variable name could be changed from HIDE_PRODUCTION_WARNING to something that's Django specific, ie. DJANGO_HIDE_PRODUCTION_WARNING?
That would align the name with a lot of the other env variable names that Django uses and would reduce potential confusion for an unfamiliar engineer seeing the env variable name being set.
Change History (11)
comment:1 by , 8 months ago
| Cc: | added |
|---|---|
| Severity: | Normal → Release blocker |
| Triage Stage: | Unreviewed → Accepted |
comment:2 by , 8 months ago
Even more explicit could be something like DJANGO_RUNSERVER_HIDE_PRODUCTION_WARNING. That would make it very clear that it's only a variable for the management command - but that may be too long of a name?
comment:3 by , 8 months ago
I agree with the rationale and with the ticket acceptance. My proposal would be to use: DJANGO_RUNSERVER_HIDE_WARNING (since I don't think the PRODUCTION provides any extra information here and to me it feels a bit confusing).
comment:4 by , 8 months ago
This all sounds reasonable, if I remember correctly the original name matches the command line flag, which I don't think needs to change in this case?
comment:5 by , 8 months ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:6 by , 8 months ago
| Has patch: | set |
|---|
comment:8 by , 8 months ago
| Patch needs improvement: | set |
|---|
comment:9 by , 8 months ago
| Patch needs improvement: | unset |
|---|---|
| Triage Stage: | Accepted → Ready for checkin |
I think I agree here, other env vars include
DJANGO_SETTINGS_MODULE,DJANGO_COLORS,DJANGO_SUPERUSER_PASSWORD,DJANGO_WATCHMAN_TIMEOUT,DJANGO_ALLOW_ASYNC_UNSAFE.