Opened 3 years ago

Last modified 17 months ago

#24989 assigned New feature

Introduce contributor facing documentation for django.db.migrations

Reported by: Markus Holtermann Owned by: Markus Holtermann
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Markus Holtermann)

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. Tim proposed to add that documentation to docs/internals/. I'd put it into docs/internals/api/

E.g. 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.

Change History (3)

comment:1 Changed 3 years ago by Tim Graham

I think the idea is accepted, but a ticket is needed for each thing you want to document, not all of them in one ticket. Do you want to retitle this one to cover migrations?

comment:2 Changed 3 years ago by Markus Holtermann

Description: modified (diff)
Owner: changed from nobody to Markus Holtermann
Status: newassigned
Summary: Introduce low-level documentation on Django's componentsIntroduce contributor facing documentation for django.db.migrations
Triage Stage: UnreviewedAccepted

comment:3 Changed 17 months ago by Akshesh Doshi

Commenting to subscribe to this ticket.

(Cannot add to cc as being detected as spam)

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