Opened 8 years ago

Closed 8 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: master
Severity: Keywords:
Cc: Triage Stage: Design decision needed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

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)

generic_relations_warning.diff (1.1 KB) - added by enlight 8 years ago.

Download all attachments as: .zip

Change History (4)

Changed 8 years ago by enlight

comment:1 Changed 8 years ago by Vadim Macagon <vadim@…>

  • Has patch set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

comment:2 Changed 8 years ago by Simon G. <dev@…>

  • Triage Stage changed from Unreviewed to Design decision needed

comment:3 Changed 8 years ago by mtredinnick

  • Resolution set to wontfix
  • Status changed from new to 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.

Note: See TracTickets for help on using tickets.
Back to Top