On 26 Mai, 23:51, Robert Bradshaw <rober...@math.washington.edu>
wrote:
> On May 26, 2010, at 12:49 PM, Jason Grout wrote:
> > Right now, of course, you could point to the listing given in the  
> > release notes.  However, often the trac ticket titles are (1) not  
> > very descriptive, (2) often poorly reflect what is actually in the  
> > patch, and (3) do not give any information about deprecations or  
> > other user-visible changes.  On the other hand, reading all of the  
> > discussion on all of the trac tickets and then looking at all of the  
> > patches is clearly out of the question for most users to see what  
> > changed.
>
> Trac ticket titles and descriptions should be updated as a ticket  
> evolves. Ideally
>
> http://trac.sagemath.org/sage_trac/query?group=component&milestone=sa...
>
> should be a good summary of what happened.

Should, *Ideally* ...

> > Of course, an alternative is to just make a special section of the  
> > commit message detailing possible compatibility issues, and then  
> > just automatically pull those out when making a release.  If we did  
> > that, commit messages could be something like docstrings with  
> > sections for features added, compatibility issues, other user-
> > visible changes, etc. Wow, that sounds like a lot of work too.  But  
> > it could make Sage much more user-friendly.
>
> That would be cool too, actually ideal.

Again, it's easier to adapt, i.e. copy, paste and edit a previous
changelog entry, than recalling or looking up the structure of such
rich commit messages. Ideally, Mercurial would provide the fields to
fill (like trac, though I still consider it sub-optimal, too) - with a
brief, concise explanation.

-Leif

-- 
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel+unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org

Reply via email to