#25485: Deprecation notice on GenericRelation is confusing
-------------------------------+--------------------
Reporter: tarkatronic | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
In looking up the documentation for GenericRelation, I ran across the
deprecation notice which looks like:
class GenericRelation
Deprecated since version 1.7:
This class used to be defined in django.contrib.contenttypes.generic.
Support for importing from this old location will be removed in Django
1.9.
This was initially confusing to me for two reasons. To alleviate
repetition, here's the related conversation from IRC:
< TheJoey> Is it just me, or is this deprecation notice a bit confusing?
https://docs.djangoproject.com/en/1.8/ref/contrib/contenttypes/#reverse-
generic-relations
< moldy> TheJoey: not to me
< TheJoey> moldy: It makes it sound to me, at first, like
GenericRelation itself is deprecated. And then it goes on to say that the
old location will be removed, but not where the new location is.
< moldy> TheJoey: i do wish that the reference docs would say "class
the.import.path.Object" in these headings (the <dt>), but that's a more
general issue
< giarc> TheJoey a little... it'd be nice to have the current import
location mentioned
< TheJoey> moldy: Or at least showing more import statements in the
example code
< TheJoey> Problem is, just looking at this doc, I have no idea where to
pluck GenericRelation from. Except that I just read something earlier
today about that particular deprecation, so I already have an idea where
to look.
Perhaps this could be stated more along the lines of "This class
definition was moved from django.contrib.contenttypes.generic to
django.contrib.contenttypes.fields", or the example below could actually
show the import.
--
Ticket URL: <https://code.djangoproject.com/ticket/25485>
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/054.fdb1bb17a3171f0fbd881d7ba7fae0ff%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
