Re: Doc: improve doc on markup command writing (issue157133)

[Carl Sorensen]

On 11/22/09 10:50 AM, "Nicolas Sceaux" <address@hidden> wrote:

> Le 22 nov. 2009 à 17:10, Graham Percival a écrit :
> 
>> On Sun, Nov 22, 2009 at 3:37 PM,  <address@hidden> wrote:
>>> As I'm not (obviously) a native English speaker, comments on style are
>>> most welcome.
>> 
>> Whenever I try to publish my comments, I get a 500 server error.  :(
>> I'll summarize them below:
>> - use @var{foo} for variable names.  This applies to both the .itely
>> file, and also the .scm file (instead of `props')
> 
> Actually, this variable (where properties are accumulated) is named
> `props' everywhere in scm/define-markup-command.scm.  I change other
> meaningless argument names to foo.
> 


I think that what Graham meant was you should use @var{props} instead of
`props'.

The way we indicate a variable name in the documentation is not with CAPS or
with 'single quotes' but with @var{macro}.

Thanks,

Carl