Added the word TODO in comments

Started by Gurjeet Singhabout 19 years ago6 messages
#1Gurjeet Singh
singh.gurjeet@gmail.com
1 attachment(s)

This just so that somebody looking for TODO items in the source can find
this one too.

Regards,

--
gurjeet[.singh]@EnterpriseDB.com
singh.gurjeet@{ gmail | hotmail | yahoo }.com

Attachments:

TODO.patchapplication/octet-stream; name=TODO.patchDownload
Index: src/backend/access/common/indextuple.c
===================================================================
RCS file: E:\dev\repositories\pg/pgsql/src/backend/access/common/indextuple.c,v
retrieving revision 1.79
diff -c -r1.79 indextuple.c
*** src/backend/access/common/indextuple.c	14 Jul 2006 19:05:52 -0000	1.79
--- src/backend/access/common/indextuple.c	31 Dec 2006 08:13:18 -0000
***************
*** 70,76 ****
  
  		/*
  		 * If value is stored EXTERNAL, must fetch it so we are not depending
! 		 * on outside storage.	This should be improved someday.
  		 */
  		if (VARATT_IS_EXTERNAL(values[i]))
  		{
--- 70,76 ----
  
  		/*
  		 * If value is stored EXTERNAL, must fetch it so we are not depending
! 		 * on outside storage.	TODO: This should be improved someday.
  		 */
  		if (VARATT_IS_EXTERNAL(values[i]))
  		{
#2Tom Lane
tgl@sss.pgh.pa.us
In reply to: Gurjeet Singh (#1)
Re: Added the word TODO in comments

"Gurjeet Singh" <singh.gurjeet@gmail.com> writes:

This just so that somebody looking for TODO items in the source can find
this one too.

If you're looking for TODO items, why wouldn't you be looking in the
TODO document?

regards, tom lane

#3Gurjeet Singh
singh.gurjeet@gmail.com
In reply to: Tom Lane (#2)
Re: Added the word TODO in comments

The comment, "This should be improved someday" sure sounds like a TODO to
me.

I don't know if it should make it to the TODO doc, as that lists
high-level/abstract feature-request-like items.

Probably I should stop acting on impulse here. Hey, can someone around here
lend me his rock!! ( no offence intended :)

Best wishes to all in the new year...

Best regards,

--
gurjeet[.singh]@EnterpriseDB.com
singh.gurjeet@{ gmail | hotmail | yahoo }.com

Show quoted text

On 12/31/06, Tom Lane <tgl@sss.pgh.pa.us> wrote:

"Gurjeet Singh" <singh.gurjeet@gmail.com> writes:

This just so that somebody looking for TODO items in the source can find
this one too.

If you're looking for TODO items, why wouldn't you be looking in the
TODO document?

regards, tom lane

#4Jim Nasby
decibel@decibel.org
In reply to: Gurjeet Singh (#3)
Re: Added the word TODO in comments

On Jan 1, 2007, at 2:24 AM, Gurjeet Singh wrote:

The comment, "This should be improved someday" sure sounds like a
TODO to me.

I don't know if it should make it to the TODO doc, as that lists
high-level/abstract feature-request-like items.

Given that the TODO list is the official compilation of things that
need to get done, ISTM that anything warranting a TODO or XXX in the
code should probably be on the TODO list. Leaving the TODO or XXX in
the code is fine, since someone might be inspired to fix it while
noodling around, but something not on the TODO is much less likely to
get fixed.
--
Jim Nasby jim@nasby.net
EnterpriseDB http://enterprisedb.com 512.569.9461 (cell)

#5Neil Conway
neilc@samurai.com
In reply to: Jim Nasby (#4)
Re: Added the word TODO in comments

On Wed, 3 Jan 2007 10:16:41 -0500
Jim Nasby <decibel@decibel.org> wrote:

Given that the TODO list is the official compilation of things that
need to get done, ISTM that anything warranting a TODO or XXX in the
code should probably be on the TODO list.

There are a wide class of possible improvements / fixes that are too small to bother adding to the TODO list, but should still be recorded somewhere. Recording those improvements in the source code seems better than not recording them at all.

Also, minor improvements to some part of the implementation are typically dependent on their context in the source code. Since TODO entries are often lacking in context as it is, I don't think trying to move everything to the TODO list would be wise.

-Neil

#6Jim C. Nasby
jim@nasby.net
In reply to: Neil Conway (#5)
Re: Added the word TODO in comments

On Wed, Jan 10, 2007 at 02:45:24PM -0500, Neil Conway wrote:

On Wed, 3 Jan 2007 10:16:41 -0500
Jim Nasby <decibel@decibel.org> wrote:

Given that the TODO list is the official compilation of things that
need to get done, ISTM that anything warranting a TODO or XXX in the
code should probably be on the TODO list.

There are a wide class of possible improvements / fixes that are too small to bother adding to the TODO list, but should still be recorded somewhere. Recording those improvements in the source code seems better than not recording them at all.

Also, minor improvements to some part of the implementation are typically dependent on their context in the source code. Since TODO entries are often lacking in context as it is, I don't think trying to move everything to the TODO list would be wise.

Yeah, 'anything' is too strong... but I've certainly run across some
stuff that could go into the TODO. There's some things in there
questioning algorithm choices that probably won't ever get done unless
someone goes and researches them, for example.
--
Jim Nasby jim@nasby.net
EnterpriseDB http://enterprisedb.com 512.569.9461 (cell)