#23725: Inconsistent documentation about ForeignKey(User)
--------------------------------------+--------------------
Reporter: raulcd | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.7
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+--------------------
In the documentation when we are saying to reference to the User model we
say
(https://github.com/django/django/blob/master/docs/topics/auth/customizing.txt#L429):
{{{
#!div style="font-size: 80%"
Code highlighting:
{{{#!python
When you define a foreign key or many-to-many relations to the User model,
you should specify the custom model using the :setting:`AUTH_USER_MODEL`
setting.
}}}
}}}
We also recommend to use it in troubleshooting here
(https://github.com/django/django/blob/master/docs/ref/applications.txt#L402)
But in other parts of the documentation we are still referring and having
examples to do it from the User model on django.contrib.auth.models
directly
(https://github.com/django/django/blob/master/docs/ref/models/fields.txt#L1264,
https://github.com/django/django/blob/master/docs/topics/auth/customizing.txt#L311):
{{{
#!div style="font-size: 80%"
Code highlighting:
{{{#!python
from django.contrib.auth.models import User
}}}
}}}
Shouldn't it be good to have consistency and to remove the later examples
to match the ones we recommend?
--
Ticket URL: <https://code.djangoproject.com/ticket/23725>
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 [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/049.edfda7286a1f059514cb166551b1fb88%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
