RE: [GT] SVN Commit r585 - in trunk/GT: . DB Systems

["Weigert, Thomas" <weigert AT mst.edu>]

I'll put the comment back in, if you feel it should be. 

I felt that you were expressing a general principle, namely that one
should make sure that related constructs were ordered similarly. This
applies also, e.g., to the parameter handling in scripts (initialization
and setup, for example).

My rational was that in any coding standards that I have seen, comments
were focused on functionality, and process remarks were disallowed. But
this is not very critical. What is important is that we work towards
improvements and that people understand the code. 

Th.

> -----Original Message-----
> From: Robert A. Schmied [mailto:ras
AT
acm.org]
> Sent: Friday, March 21, 2008 1:00 PM
> To: devel
AT
geniustrader.org
> Subject: Re: [GT] SVN Commit r585 - in trunk/GT: . DB Systems
> 
> Weigert, Thomas wrote:
> > ras,
> >
> > I think that comments should relate to the functionality of the code
and
> > should help to explain the reader what the code does.
> 
> and where appropriate, clues to the new reader why things are
organized
> the way the are
> 
> >
> > Your comment below is about stylistic rules that one should follow.
I
> > think these rules should either be documented in a "Guidelines for
GT
> > development" or should be in the checkin comment to explain why the
> > change was made.
> 
> but "Guidelines for GT development" doesn't exist
> 
> besides why does one have look in multiple places to find out why
> things are ordered the way they are? as i think %EXPORT_TAGS
> and @EXPORT_OK are shown completely together for this one module
> it made sense to me to note it in a comment -- especially considering
> the prior disorder.
> 
> >                  They do not help as comments.
> 
> we simply will continue to disagree on this ...
> 
> >
> > My 2c.
> >
> > Th.
> >
> >
> >>-----Original Message-----
> >>From: Robert A. Schmied [mailto:ras
AT
acm.org]
> >>Sent: Friday, March 21, 2008 12:04 PM
> >>To: devel
AT
geniustrader.org
> >>Subject: Re: [GT] SVN Commit r585 - in trunk/GT: . DB Systems
> >>
> >>GeniusTrader SVN wrote:
> >>
> >>>Author: thomas
> >>>Date: 2008-03-21 05:13:32 +0100 (Fri, 21 Mar 2008)
> >>>New Revision: 585
> >>>
> >>>Modified:
> >>>   trunk/GT/DB/Text.pm
> >>>   trunk/GT/Prices.pm
> >>>   trunk/GT/Systems/AlwaysInTheMarket.pm
> >>>   trunk/GT/Tools.pm
> >>>Log:
> >>>Update documentation.
> >>
> >>>Modified: trunk/GT/Tools.pm
> >>>===================================================================
> >>>--- trunk/GT/Tools.pm	2008-03-21 03:02:41 UTC (rev 584)
> >>>+++ trunk/GT/Tools.pm	2008-03-21 04:13:32 UTC (rev 585)
> >>>@@ -12,9 +12,6 @@
> >>>
> >>> require Exporter;
> >>> @ISA = qw(Exporter);
> >>>-#
> >>>-# these are ordered and grouped to correspond with %EXPORT_TAGS
> >>>-#
> >>
> >>i'd disagree that removing the above comment helps, but rather
> >>detracts from future efforts at enhancement and maintenance
> >>
> >>ras
> >>
> >>
> >>> @EXPORT_OK = qw(min max PI sign
> >>>                 extract_object_number
> >>>                 resolve_alias resolve_object_alias long_name
> >
> > short_name
> >
> >>>
> >
> >