#25710: Clarify the docs about what INTERNAL_IPS does --------------------------------------+------------------------------------ Reporter: knbk | Owner: nobody Type: Cleanup/optimization | Status: new Component: Documentation | Version: 1.8 Severity: Normal | Resolution: Keywords: | Triage Stage: Accepted Has patch: 0 | Needs documentation: 0 Needs tests: 0 | Patch needs improvement: 0 Easy pickings: 1 | UI/UX: 0 --------------------------------------+------------------------------------
Comment (by alexmorozov): Guys, could you please elaborate on what specifically must be documented? `INTERNAL_IPS` is now used at three places (except tests): 1. `django.template.context_processors.debug` to add SQL queries to context. Its docs mention the setting. Is it enough? 2. `django.contrib.admindocs.middleware.XViewMiddleware` to add an X-View header. Docs mention the setting. Should we refactor documentation? I hardly can imagine what to add about the middleware itself. 3. `django.utils.log.AdminEmailHandler` to prefix an email subject with an 'internal'/'EXTERNAL' marks. Should we mention the setting [https://docs.djangoproject.com/en/1.8/topics/logging/#django.utils.log.AdminEmailHandler here]? As for the `DEBUG` documentation, it seems pretty complete to me, since this setting has no direct relation to the `INTERNAL_IPS`. Am I wrong? -- Ticket URL: <https://code.djangoproject.com/ticket/25710#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 django-updates+unsubscr...@googlegroups.com. To post to this group, send email to django-updates@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/062.a414adb65fee3cf43dee5451f4d834f2%40djangoproject.com. For more options, visit https://groups.google.com/d/optout.