Re: [eigen] documentation: the long tutorial
• To: eigen@xxxxxxxxxxxxxxxxxxx
• Subject: Re: [eigen] documentation: the long tutorial
• From: Carlos Becker <carlosbecker@xxxxxxxxx>
• Date: Sun, 20 Jun 2010 13:01:52 +0100
• Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:received:received:in-reply-to :references:date:message-id:subject:from:to:content-type; bh=OR43bGInt5LQJm5Y0pAHu1ui9b2OVMrYIrFwIqzEg/s=; b=AJySuOlWyB+6UYQjdujPZkFIyiDQbswgf6HKKYl0mEkhFZxbuMztXr0nFRbrENF1Ur KAAwfgGY3qO4cpvZXHDgo+lra0QPUEIG0Gaoj5f6+oDptqfwaRr3FdPtjS6aFTjdfApT z6SYk5j/PiIFBCLRwUMbQ7Ncbd11r0exvTlW8=
• Domainkey-signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type; b=CBozWEbVHS/KUAEVbSQ58eu9Hv7dLu80PhPQaWkg4fNPPREHdGrhp+EWi7F92GNSuq y2EpKXV0IQ5SOqxA/bGfNxzLyz22HlFzZy99qfBYIa6LTP9LA126cyYiCytdYDD/zuO1 d+HEMjBagy9APBrliCJJ6FFnhJgyxHxocHulo=

I think it is a good idea. I believe it would be nice to have some sort of 'yellow-highlighted text' so it becomes more obvious, even though there might be reasons to avoid that too.

So far I am sticking to the FIXME format, but I am open to any changes regarding that. Usually I use \hl{something} in latex so I can spot the TODO's easily while reading the output. Anyways, this is not latex :(

On Sat, Jun 19, 2010 at 11:50 PM, Robert Lupton the Good wrote:
> Just write FIXME in plain text, as we do in the code, no particular
> dox/html tag.

The doxy tag to use would be \todo:

> \todo { paragraph describing what is to be done }
>
> Starts a paragraph where a TODO item is described. The description will also add an item to a separate TODO list. The two instances of the description will be cross-referenced. Each item in the TODO list will be preceded by a header that indicates the origin of the item.

Wouldn't it be worth using it?

R

 Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/