This is fine with me. If nobody else complains in a day
or two, check it in.
> -----Original Message-----
> From: Matthew McEachen [mailto:mceachen@...]
> Sent: Tuesday, November 20, 2001 11:59 PM
> To: gallery-devel@...
> Subject: [Gallery-devel] Change/supplement to coding standards
> I was looking at the coding standard one more time, and winced at the
> "FIXME/REVISIT/TODO" section...
> Admittedly, the projects I've used this on were with a team all in
> shouting/reach-over-n-whack-upside-head distance - I think
> the idea of
> arguing "is this a hack" vs. "this is not a hack, but should
> be checked by
> someone else" is an avoidable peril. Chris' earlier comments
> are certainly
> I guess all I need/want is to be able to mark, in some way,
> * "This is completely wack/bogus/notNearlyDone/stubbed and
> I'm going to fix
> it, honest, RSN" (marked with XXX or TODO or BUGBUGBUG or ...
> followed by
> username and datestamp)
> * "Could someone else (maybe even me) check this and see if I
> was on crack--I
> don't think I was, but..." (marked with REVISIT or LATER or
> CHECKME or HORKED
> or MYBUTTISITCHY or ... followed by username and datestamp)
> BTW, you are witness, below, to my attempt to clarify the
> section. I failed.
> Which inspired this email in the first place.
> Anyway, happy T-day!
> [mrm@... dev]$ cvs diff coding_standards.html
> Index: coding_standards.html
> RCS file: /cvsroot/gallery/docs/dev/coding_standards.html,v
> retrieving revision 1.5
> diff -r1.5 coding_standards.html
> < following tags in a comment, above the code in question:
> > following tags in a comment, above the code in
> question. Including
> > your username (and perhaps a date) doesn't hurt. In
> order of severity:
> < <li><b>REVISIT</b> - this is an optimization waiting
> to happen,
> < or something that could be improved on later. Optionally. If
> < we're bored. And have itchy C-x v v fingers.
> < <li><b>TODO</b> - this is missing functionality (so by
> < definition, it's broken) that needs to be addressed at some
> < point.
> < <li><b>FIXME</b> - this is stubbed/broken functionality. But I
> < need to commit. And it can limp for now.
> > <li><b>REVISIT</b> (is this the way we want to do
> it?) - Either
> > you want someone else to validate the code, or you
> thought of an
> > optimization that can be postponed indefinitely. The code
> > works, however, and it doesn't smell "hacky".<br /><br />
> > <li><b>FIXME</b> (this is <i>not</i> the way we want
> to do it) -
> > This is bogus/hacked functionality. It limps, and casual
> > bystanders can tell. It may even have bugs you know about. <br
> > /><br />
> > <li><b>TODO</b> (this isn't done) - This is missing
> > functionality (according to the current feature requirements)
> > that needs to be implemented at some point.
> list: Gallery-devel@...
> info: https://lists.sourceforge.net/lists/listinfo/gallery-devel
> archive: http://marc.theaimsgroup.com/?l=gallery-devel