#24989: Introduce low-level documentation on Django's components
-----------------------------------------+------------------------
Reporter: MarkusH | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
I first had the idea a Django: Under the Hood 2014, but abandoned it. A
couple of days ago the idea came up in IRC again:
It would be helpful for new contributors as well as for other core devs
not involved in certain parts of Django, to have documentation that
outlines how these components work.
I.e. in migrations: you have a `ModelState` and to detect changes the
autodetector takes all migrations and build the final model representation
and then compares this `ProjectState` to the `ProjectState` constructed
from all currently available models.
Tim proposed to add that documentation to `docs/internals/`. I'd put it
into `docs/internals/api/`
--
Ticket URL: <https://code.djangoproject.com/ticket/24989>
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/050.a636fd0fce1b3866bf4455789566e2c3%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
