Opened 18 years ago
Closed 18 years ago
#3744 closed (wontfix)
Warn that Generic Relations are a prototype feature (in the right places).
Reported by: | enlight | Owned by: | Jacob |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Keywords: | ||
Cc: | Triage Stage: | Design decision needed | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
There was a thread on django-users recently ("GenericRelation and serialization") where Russell Keith-Magee wrote:
"GenericRelations are a bit of a wierd case - they're available in Django, but they're still a prototype feature - they're not fully documented, and they're not as well tested as other aspects of Django."
This was a bit of a shock to me, I knew they were barely documented, but I didn't realise they were a prototype feature. Since I didn't recall any such warning in the scarce documentation on generic relations - I went looking for it, sure enough I found it at the end of the "Branches in development" section over on this page http://code.djangoproject.com. That explains why I didn't recall it, I wasn't expecting any of the text in that section to apply to the trunk.
The warning should really be moved to the following places where I would've actually noticed and paid attention to it:
http://code.djangoproject.com/browser/django/trunk/django/db/models/fields/generic.py
and
http://www.djangoproject.com/documentation/models/generic_relations/
I'll see about creating a patch for this tomorrow.
Attachments (1)
Change History (4)
by , 18 years ago
Attachment: | generic_relations_warning.diff added |
---|
comment:1 by , 18 years ago
Has patch: | set |
---|
comment:2 by , 18 years ago
Triage Stage: | Unreviewed → Design decision needed |
---|
comment:3 by , 18 years ago
Resolution: | → wontfix |
---|---|
Status: | new → closed |
It's better that we fix the real problem here: which is moving generic relation to their right home in the source tree. That will be done soon. The current instability in the API is documented in api-stability.txt.