#30222: documentation bug for base managers
-----------------------------------------+------------------------------
Reporter: David Gudeman | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 2.1
Severity: Normal | Keywords: base_manager
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------------
The documentation
(https://docs.djangoproject.com/en/2.2/topics/db/managers/#base-managers)
for "Managers->Base managers" seems to contradict itself:
para 1, line 1: "By default, Django uses an instance of the
Model._base_manager manager class when accessing related objects"
para 3, line 1: "Base managers aren’t used when querying on related
models."
This is reinforced with an example in para 3, but is then (apparently)
contradicted again:
para 4, line 1: "This manager is used to access objects that are related
to from some other model."
Furthermore, para 3 give an example of a base model that filters out some
rows and then in the next section we get a scary-sounding warning not to
do that or bad things will happen. But the scary warning is odd because it
seems to be warning me that it will do exactly what I intend it to do. If
I use the example from para 3, then I *want* it to filter out deleted
rows. Why is that bad? And especially, why is it bad when para 3 says it
won't work anyway?
Finally, para 1 and 2 seem to say that to change Model._base_manager I
should change Meta.base_manager_name, but doesn't say what the difference
it makes.
--
Ticket URL: <https://code.djangoproject.com/ticket/30222>
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/056.e942207a499e835525a8ca15de50b2a7%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
