[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: doc question: @example inside @warning?
From: |
Graham Percival |
Subject: |
Re: doc question: @example inside @warning? |
Date: |
Sun, 20 Dec 2009 10:34:03 +0000 |
User-agent: |
Mutt/1.5.18 (2008-05-17) |
On Sat, Dec 19, 2009 at 09:24:44PM -0800, Joe Neeman wrote:
> If you have a look at commit 06b6383aca113, you'll see a commented out
> paragraph that looks like this:
>
> @c FIXME: is it possible to have @example inside @warning?
No; macros can't have blank lines inside them, and @example
qualifies. I've run into this before. If this is going in the
NR, make it a @knownissue instead. Otherwise, just condense it
down to a few sentences.
This limitation doesn't bug me _too_ much, since @warning should
be used sparingly, otherwise it'll lose its impact.
Cheers,
- Graham