#35772: Document models.Field.contribute_to_class
-------------------------------------+-------------------------------------
Reporter: Clifford Gama | Owner: Clifford
Type: | Gama
Cleanup/optimization | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: wontfix
Keywords: contribute_to_class | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Natalia Bidart):
* cc: Simon Charette, Mariusz Felisiak (added)
Comment:
Replying to [comment:2 Clifford Gama]:
> Hello! and thank you, Natalia, for the detailed review and the community
resources on `contribute_to_class` -- they were very informative.
You are welcome!
> I'm not very much in favour of making `contribute_to_class` a part of
the public API, so I will not start a discussion in the forum for that.
Right, me neither.
> However, if we agree that, as it currently stands, `contribute_to_class`
is "an undocumented, private, internal API" then I believe we should also
remove it from the docs entirely, since having it there canonises it as
part of the public API, in which case it would have to be officially
documented. Having it in there while maintaining its status as a private
part of the API is a bit in the gray area.
I half-agree with this. I do think that it's weird to mention something in
the public docs that is not public, but at the same time, providing that
pointer could be very useful for some very specific cases.
My proposal to go to the forum can instead be repurposed to ask for
feedback about removing the reference, or leaving it as is, un-referenced?
--
Ticket URL: <https://code.djangoproject.com/ticket/35772#comment:3>
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 view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/010701920a5dfcfa-c0bc2ff8-1957-400d-8c1e-620adb5e1c88-000000%40eu-central-1.amazonses.com.
