Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#8255 closed (wontfix)

Nobody reads the BackwardsIncompatibleChanges page

Reported by: daonb <bennydaon@…> Owned by: nobody
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: UI/UX:

Description

From the django irc room:

out))
[10:49am] daonb: I'm trying to test the trunk and here's what I'm getting - http://dpaste.com/70874/ - 
I'm using 2.5.1 and postgres_psycopg2 on a OSX 10.5
[10:54am] Matro: huh, was get_<field>_filename removed?
[10:55am] mattmcc: Nobody reads the BackwardsIncompatibleChanges page.
[10:56am] Matro: I kept finding the one from the last revision
[10:56am] Matro:
[10:56am] mattmcc: http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges#Filestoragerefactoring
[10:58am] daonb: I'll read it, but I just did an 'svn up' and 'python setup.py install' and tested my installation. 
using runtests.pt. It should pass out of the box
[10:58am] 

Attachments (1)

README.diff (580 bytes) - added by daonb <bennydaon@…> 7 years ago.
Add a link to the compatibility wiki page

Download all attachments as: .zip

Change History (7)

comment:1 Changed 7 years ago by russellm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to invalid
  • Status changed from new to closed

What's your point? This isn't a bug report, it's a casual observation of common human behavior.

Changed 7 years ago by daonb <bennydaon@…>

Add a link to the compatibility wiki page

comment:2 Changed 7 years ago by daonb <bennydaon@…>

  • Component changed from Uncategorized to Documentation
  • Has patch set
  • Resolution invalid deleted
  • Status changed from closed to reopened

I behaved like that because I didn't know where to look for documentation. Some people don't read it because they don't know about it. 1.0 can help by pointing us ignorant 0.96 users to the right doc.
(I meant to added my patch when I opened the ticket but I mistakenly pressed submit without attaching this small documentation fix, sorry.)

comment:3 Changed 7 years ago by julianb

  • Patch needs improvement set

No one reads the README. But it is true that the BackwardsIncompatibleChanges might be difficult to find for new users. Is it linked from the docs etc.?

comment:4 Changed 7 years ago by daonb

There are a few links in the docs, but no definitive guide:

$ grep -i -l incompatib docs/*.txt
docs/index.txt
docs/install.txt
docs/release_notes_0.96.txt
docs/release_notes_1.0_alpha.txt
docs/release_notes_1.0_alpha_2.txt

I'm an 0.96.2 developer and am struggling with 1.0 (my runtests.py still fails). IMHO we should improve the docs by focusing on helping 0.9X users migrate to 1.0. If you're interested, I can turn the wiki page into a doc where errors like the one below are mapped to compatibility issues :

  File "/Library/Python/2.5/site-packages/django/db/models/fields/__init__.py", line 430, in Field
    def formfield(self, form_class=forms.CharField, **kwargs):
AttributeError: 'module' object has no attribute 'CharField'

As for the README, If only one person reads it, we should delete it.

comment:5 Changed 7 years ago by mtredinnick

  • Resolution set to wontfix
  • Status changed from reopened to closed

Please don't reopen tickets that have been marked as wontfix. We will prepare a porting guide as we get a bit closer to 1.0. There are just higher priorities right now. You should feel free to start a wiki page to do just that to get the ball rolling if you like. Don't change the BackwardsIncompatibleChanges page, since that's already serving a specific purpose. But by all means start a new page.

It wouldn't be appropriate add a link to the README, since that file is for the release, not a pointer to highly active in-development, always-changing code. It serves a different purpose than for people using an absolutely latest checkout. So I'm going to reclose as wontfix, since the premise of the ticket is inaccurate and the actual problem you seem to be having (forwards porting from 0.96 to 1.0) is something we'll try to help people solve more directly for 1.0.

comment:6 Changed 7 years ago by gwilson

Malcolm beat me to it, but yes, we are interested in a porting guide for 0.96 users upgrading to 1.0. You could use the BackwardsIncompatibleChanges page as a start; however, we would like something polished with the intention of being included in the official documentation for the 1.0 release. This means that it should be a ReST document that organizes the changes into logical sections, with emphasis on the higher-impact changes.

But please, open a new ticket for this.

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