Hi all,

The online docs can easily give the impression that we have perfect 
compatibility with Django 1.0 — the 'Django over time' section on [1] 
has a link to 'Backwards-incompatible changes' [2], which contains 
pre-1.0 changes only, and a notice at the top saying you don't need to 
read it if your code is post 1.0.  Also, the archive of release notes 
[3] incorrectly says that BackwardIncompatibleChanges is the place to 
look for those following trunk.  It's a bit of a mess actually.

The truth about backwards incompatibilities is slightly more complex, 
as the release notes of 1.1 show.  But we don't currently have a good 
place to point people to.  Release notes are a bit awkward, because it 
can be confusing trying to work out which you should read.  If I'm 
upgrading from 1.0 to 1.2, do I need to dig out the notes for 1.1 as 
well?  What about 1.1 RC1, beta 1, alpha 1?  We also need a place for 
people following trunk to refer to.

I'm proposing UpgradingNotes [4], which I've just started throwing 
together.  It has everything you need to know in one place.  It has 
notes for trunk at the top, and links to all the release notes you 
need to read, newest release first.

This way, the contents of the top section of this page will be edited  
(mainly by committers, but possibly by other users) while there is any 
flux in trunk, and it will become part of the release notes when the 
next version is released.

Also, the current FutureBackwardsIncompatibleChanges [5] is really 
just duplication of part of the 'Deprecation Timeline' docs [6].  I 
think the former should be removed.

Thoughts?  If other people think this is the right idea, links from 
the official docs to BackwardsIncompatibleChanges just need to be 
changed to UpgradingNotes.

Luke

[1] http://docs.djangoproject.com/en/dev/
[2] http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges
[3] http://docs.djangoproject.com/en/dev/releases/
[4] http://code.djangoproject.com/wiki/UpgradingNotes
[5] 
http://code.djangoproject.com/wiki/FutureBackwardsIncompatibleChanges
[6] http://docs.djangoproject.com/en/dev/internals/deprecation/

-- 
As Ralph Waldo Emerson once said, "I hate quotations." 

Luke Plant || http://lukeplant.me.uk/

--

You received this message because you are subscribed to the Google Groups 
"Django developers" group.
To post to this group, send email to django-develop...@googlegroups.com.
To unsubscribe from this group, send email to 
django-developers+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-developers?hl=.


Reply via email to