#24106: Document backwards incompatible changes to database backend API
---------------------------------+------------------------------------
Reporter: akaariai | Owner: nobody
Type: New feature | Status: new
Component: Documentation | Version: master
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
---------------------------------+------------------------------------
Changes (by timgraham):
* component: Database layer (models, ORM) => Documentation
Old description:
> I believe we don't have a separate ticket for documenting backwards
> incompatible changes to database backend API. In duth it was agreed that
> we want to do this.
>
> An idea of how to do this is to log/diff changes to Django's backends
> between stable/1.7 and master. Going through the changes in Django should
> give a good approximation of all the breaking changes (another place
> where breakage is possible is Compiler module).
>
> If possible, I'd like to document the changes in a way that is both
> backwards and forwards compatible. That is, we give a replacement
> suggestion that works both in 1.7 and 1.8 (very likely conditional on
> Django version).
New description:
I believe we don't have a separate ticket for documenting backwards
incompatible changes to database backend API. At Django Under the Hood it
was agreed that we want to do this.
An idea of how to do this is to log/diff changes to Django's backends
between stable/1.7 and master. Going through the changes in Django should
give a good approximation of all the breaking changes (another place where
breakage is possible is Compiler module).
If possible, I'd like to document the changes in a way that is both
backwards and forwards compatible. That is, we give a replacement
suggestion that works both in 1.7 and 1.8 (very likely conditional on
Django version).
--
Comment:
In my opinion, there is no need to document the changes in a way that is
both backwards and forwards compatible. django-mssql, at least, does not
attempt to support multiple versions of Django. I believe try to support
multiple versions of Django would be more effort than it's worth (after
all, we don't have this required for any backends in core), but maybe
there are backends out there that attempt to do so. I have created
[https://groups.google.com/d/topic/django-
developers/Z6f4z_zwQYk/discussion a thread on django-developers] to get
feedback on this question and more, so that we have some guidance on what
documentation to add. Since we haven't been documenting as we go this
time, I believe the most efficient way to add this documentation will be
to do so in a reactive fashion (to reported breakages in third-party
backends) rather than trying to anticipate what parts of the API
developers are using.
--
Ticket URL: <https://code.djangoproject.com/ticket/24106#comment:1>
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/066.a4b4c0978381561156b6012363a16801%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
