2011/10/3 Łukasz Langa <[email protected]>: > Wiadomość napisana przez Russell Keith-Magee w dniu 3 paź 2011, o godz. > 16:07: > > 1) Build your own experience with the internals of the ORM. As part > of this learning process, document what you learn -- we would very > much like to have better documentation of the internals of Django's > ORM, but writing that documentation takes time. > > > How would you like to see that done? I find this interesting, if only to see > how suitable would increasing support for multiple inheritance be.
Documentation of the internals of the query engine has been on the 'nice to have' list for a long time, but I can't say I've given any deep thought to what that documentation would look like. It doesn't need to be as comprehensive as a beginners tutorial -- we can assume that if you're spelunking around the ORM internals, you're not a complete novice. A few topics you might want to cover include: * Explaining the data structures used by the query.sql module * Explaining the lifecycle of query construction * Explaining the query vs compiler separation Beyond that, he (or she) who paints the bikeshed gets to pick the color :-) I would also add that as with all documentation, the first draft is the hard draft. Once there is *some* documentation, it's a lot easier for other people to contribute and come up with suggestions about how it could be better. A first cut of accurate, lifecycle complete but detail incomplete documentation may be enough to get the ball rolling. Yours, Russ Magee %-) -- You received this message because you are subscribed to the Google Groups "Django developers" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/django-developers?hl=en.
