Re: [Math] Coding and documenting guidelines

2011-01-13 Thread sebb
On 13 January 2011 16:52, Jörg Schaible wrote: > Hi Gilles, > > Gilles Sadowski wrote: > > [snip] > >>> Yes, though I don't see big problems with formatting and I don't see the >>> need - and in fact see reasons not to - depart from the established >>> standard or add more requirements that contri

Re: [Math] Coding and documenting guidelines

2011-01-13 Thread Jörg Schaible
Hi Gilles, Gilles Sadowski wrote: [snip] >> Yes, though I don't see big problems with formatting and I don't see the >> need - and in fact see reasons not to - depart from the established >> standard or add more requirements that contributors need to follow. > > There are no big problems, just

Re: [Math] Coding and documenting guidelines

2011-01-13 Thread Gilles Sadowski
On Thu, Jan 13, 2011 at 10:34:00AM -0500, Phil Steitz wrote: > > > > > On Jan 13, 2011, at 7:21 AM, Gilles Sadowski > wrote: > > > Hi. > > > >> [...] > >>> > A couple of areas where we have slipped a bit over the years that I > would rather apply energy to than formatting are the

Re: [Math] Coding and documenting guidelines

2011-01-13 Thread Phil Steitz
On Jan 13, 2011, at 7:21 AM, Gilles Sadowski wrote: > Hi. > >> [...] >>> A couple of areas where we have slipped a bit over the years that I would rather apply energy to than formatting are the following (from the Developers' guide): # All component contracts must

Re: [Math] Coding and documenting guidelines

2011-01-13 Thread Gilles Sadowski
Hi. > [...] > > > >> A couple of areas where we have slipped a bit over the years that I > >> would rather apply energy to than formatting are the following (from > >> the Developers' guide): > >> > >> # All component contracts must be fully specified in the javadoc > >> class, interface or method

Re: [Math] Coding and documenting guidelines

2011-01-12 Thread Gilles Sadowski
On Wed, Jan 12, 2011 at 03:23:59PM -0800, Ted Dunning wrote: > I personally find it more aesthetic and much more expedient to use a > standard style guide that many people are already familiar with (more or > less, often less). > > Making up a new style guide is a waste of breath and subject to mi

Re: [Math] Coding and documenting guidelines

2011-01-12 Thread Phil Steitz
On Wed, Jan 12, 2011 at 5:32 PM, Gilles Sadowski wrote: > Hi. > >> > Is there a document presenting best practices for writing code for CM? >> > Right now I'm thinking about the recent overwrites of Javadoc comments; so >> > I >> > think that it could be useful to lay out what should be there (be

Re: [Math] Coding and documenting guidelines

2011-01-12 Thread Ted Dunning
I personally find it more aesthetic and much more expedient to use a standard style guide that many people are already familiar with (more or less, often less). Making up a new style guide is a waste of breath and subject to minor aesthetic quibbles like whether to use a phrase. The Sun guides ar

Re: [Math] Coding and documenting guidelines

2011-01-12 Thread Gilles Sadowski
Hi. > > Is there a document presenting best practices for writing code for CM? > > Right now I'm thinking about the recent overwrites of Javadoc comments; so I > > think that it could be useful to lay out what should be there (beyond the > > obvious that "everything should be documented"). > > Ye

Re: [Math] Coding and documenting guidelines

2011-01-12 Thread Phil Steitz
On Tue, Jan 11, 2011 at 10:15 AM, Gilles Sadowski wrote: > Hi. > > Is there a document presenting best practices for writing code for CM? > Right now I'm thinking about the recent overwrites of Javadoc comments; so I > think that it could be useful to lay out what should be there (beyond the > obv

Re: [Math] Coding and documenting guidelines

2011-01-12 Thread Gilles Sadowski
Hello. > On Tue, Jan 11, 2011 at 7:38 AM, sebb wrote: > > > On 11 January 2011 15:15, Gilles Sadowski > > wrote: > > > Hi. > > > > > > Is there a document presenting best practices for writing code for CM? > > > > Sun/Oracle have Javadoc conventions which should be followed. > > > > See > http

Re: [Math] Coding and documenting guidelines

2011-01-11 Thread Ted Dunning
On Tue, Jan 11, 2011 at 7:38 AM, sebb wrote: > On 11 January 2011 15:15, Gilles Sadowski > wrote: > > Hi. > > > > Is there a document presenting best practices for writing code for CM? > > Sun/Oracle have Javadoc conventions which should be followed. > See http://www.oracle.com/technetwork/java

Re: [Math] Coding and documenting guidelines

2011-01-11 Thread sebb
On 11 January 2011 15:15, Gilles Sadowski wrote: > Hi. > > Is there a document presenting best practices for writing code for CM? Sun/Oracle have Javadoc conventions which should be followed. > Right now I'm thinking about the recent overwrites of Javadoc comments; so I > think that it could be

[Math] Coding and documenting guidelines

2011-01-11 Thread Gilles Sadowski
Hi. Is there a document presenting best practices for writing code for CM? Right now I'm thinking about the recent overwrites of Javadoc comments; so I think that it could be useful to lay out what should be there (beyond the obvious that "everything should be documented"). A few things that come