[Django] #36266: HIDE_PRODUCTION_WARNING variable name is ambiguous

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo Shklovskii | Type:
| Cleanup/optimization
Status: new | Component: Core
| (Management commands)
Version: 5.2 | 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
-------------------------------------+-------------------------------------
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/36266>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------

Reporter: Leo | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce):

* cc: Andy Miller (added)
* severity: Normal => Release blocker
* stage: Unreviewed => Accepted

Comment:

I think I agree here, other env vars include `DJANGO_SETTINGS_MODULE`,
`DJANGO_COLORS`, `DJANGO_SUPERUSER_PASSWORD`, `DJANGO_WATCHMAN_TIMEOUT`,
`DJANGO_ALLOW_ASYNC_UNSAFE`.
--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:1>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Leo):

Even more explicit could be something like
`DJANGO_HIDE_RUNSERVER_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?
--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:2>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Natalia Bidart):

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).
--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:3>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Andy Miller):

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?
--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:4>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------

Reporter: Leo | Owner: Johanan
Type: | Oppong Amoateng
Cleanup/optimization | Status: assigned

Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Johanan Oppong Amoateng):

* owner: (none) => Johanan Oppong Amoateng
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:5>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo | Owner: Johanan
Type: | Oppong Amoateng
Cleanup/optimization | Status: assigned
Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Johanan Oppong Amoateng):

* has_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:6>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo | Owner: Johanan
Type: | Oppong Amoateng
Cleanup/optimization | Status: assigned
Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Johanan Oppong Amoateng):

https://github.com/django/django/pull/19287
--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:7>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo | Owner: Johanan
Type: | Oppong Amoateng
Cleanup/optimization | Status: assigned
Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:8>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo | Owner: Johanan
Type: | Oppong Amoateng
Cleanup/optimization | Status: assigned
Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Sarah Boyce):

* needs_better_patch: 1 => 0
* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:9>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo | Owner: Johanan
Type: | Oppong Amoateng

Cleanup/optimization | Status: closed

Component: Core (Management | Version: 5.2
commands) |

Severity: Release blocker | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce <42296566+sarahboyce@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"5adadf6e8c74ab14d432e9d682ca1914789386de" 5adadf6]:
{{{#!CommitTicketReference repository=""
revision="5adadf6e8c74ab14d432e9d682ca1914789386de"
Fixed #36266 -- Renamed HIDE_PRODUCTION_WARNING environment variable to
DJANGO_RUNSERVER_HIDE_WARNING.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:10>

[Django]

#36266: HIDE_PRODUCTION_WARNING variable name is ambiguous
-------------------------------------+-------------------------------------
Reporter: Leo | Owner: Johanan
Type: | Oppong Amoateng
Cleanup/optimization | Status: closed
Component: Core (Management | Version: 5.2
commands) |
Severity: Release blocker | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Sarah Boyce <42296566+sarahboyce@…>):

In [changeset:"321a5651a3928a70127b510b6aa9ea92dc8c721a" 321a5651]:
{{{#!CommitTicketReference repository=""
revision="321a5651a3928a70127b510b6aa9ea92dc8c721a"
[5.2.x] Fixed #36266 -- Renamed HIDE_PRODUCTION_WARNING environment
variable to DJANGO_RUNSERVER_HIDE_WARNING.

Backport of 5adadf6e8c74ab14d432e9d682ca1914789386de from main.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36266#comment:11>