Opened 3 days ago

Closed 23 hours ago

Last modified 23 hours ago

#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 Sarah Boyce, 3 days ago

Cc: Andy Miller added
Severity: NormalRelease blocker
Triage Stage: UnreviewedAccepted

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, 3 days 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 3 days ago by Leo (previous) (diff)

comment:3 by Natalia Bidart, 3 days 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, 3 days 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, 2 days ago

Owner: set to Johanan Oppong Amoateng
Status: newassigned

comment:6 by Johanan Oppong Amoateng, 2 days ago

Has patch: set
Version 0, edited 2 days ago by Johanan Oppong Amoateng (next)

comment:8 by Sarah Boyce, 2 days ago

Patch needs improvement: set

comment:9 by Sarah Boyce, 2 days ago

Patch needs improvement: unset
Triage Stage: AcceptedReady for checkin

comment:10 by Sarah Boyce <42296566+sarahboyce@…>, 23 hours ago

Resolution: fixed
Status: assignedclosed

In 5adadf6:

Fixed #36266 -- Renamed HIDE_PRODUCTION_WARNING environment variable to DJANGO_RUNSERVER_HIDE_WARNING.

comment:11 by Sarah Boyce <42296566+sarahboyce@…>, 23 hours ago

In 321a5651:

[5.2.x] Fixed #36266 -- Renamed HIDE_PRODUCTION_WARNING environment variable to DJANGO_RUNSERVER_HIDE_WARNING.

Backport of 5adadf6e8c74ab14d432e9d682ca1914789386de from main.

Note: See TracTickets for help on using tickets.
Back to Top