#27617: Better ORM internals documentation
-------------------------------------+-------------------------------------
Reporter: Mads Jensen | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: 1.10
Severity: Normal | Resolution:
Keywords: documentation | Triage Stage: Accepted
internals |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Josh Smeaton):
I agree, I think the ORM in particular should be documented where
possible, with the caveat that certain APIs are not subject to backwards
compatibility. An ORM architecture document sounds like the right place
for such a thing. It could start off quite high level by documenting the
modules and how a query is created. It could then go further over time by
documenting helpers like JoinPromoter and PathInfo, and especially
documenting all of the feature flags.
It'll help future ORM contributors quite a bit while supporting those in
the community that are already writing 3rd party backends with trial and
error.
It's a big job though. The tradeoff will be maintaining such a document in
the face of internal refactorings.
--
Ticket URL: <https://code.djangoproject.com/ticket/27617#comment:2>
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/068.68ad4eae764cef35ddaff04ed7668aa3%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
