Opened 16 hours ago

Last modified 6 hours ago

#36266 assigned Cleanup/optimization

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: Accepted
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.

According to the ticket's flags, the next step(s) to move this issue forward are:

  • For anyone except the patch author to review the patch using the patch review checklist and either mark the ticket as "Ready for checkin" if everything looks good, or leave comments for improvement and mark the ticket as "Patch needs improvement".

Change History (7)

comment:1 by Sarah Boyce, 16 hours ago

Cc: Andy Miller added
Severity: Normal → Release blocker
Triage Stage: Unreviewed → Accepted

I think I agree here, other env vars include DJANGO_SETTINGS_MODULE, DJANGO_COLORS, DJANGO_SUPERUSER_PASSWORD, DJANGO_WATCHMAN_TIMEOUT, DJANGO_ALLOW_ASYNC_UNSAFE.

comment:2 by Leo, 16 hours 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?

Last edited 15 hours ago by Leo (previous) (diff)

comment:3 by Natalia Bidart, 15 hours 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 Andy Miller, 15 hours 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 Johanan Oppong Amoateng, 7 hours ago

Owner: set to Johanan Oppong Amoateng
Status: new → assigned

comment:6 by Johanan Oppong Amoateng, 6 hours ago

Has patch: set

​https://github.com/django/django/pull/19287

Last edited 6 hours ago by Johanan Oppong Amoateng (previous) (diff)
Note: See TracTickets for help on using tickets.
Back to Top