[Date Prev][Date Next][Thread Prev][][Date Index][Thread Index]

Re: Call for info writers



Masatake YAMATO <jet@gyve.org> writes:

>> I also wanted to say: when you explain the meaning of a key in a @table
>> @kbd, don't forget to include in the description the name of the
>> function which the key calls, so that people can find information about
>> it.

> Do you mean we should put a function name to its table item's body?
> or just only we should put it to @findex?

We should give the function name somewhere in the description (what you
call the body, I think) *and* use the @findex.  Sorry if it was unclear.
:)

(I recently realized that most of the Gnus and Emacs manuals include the
function name in the description, so I think we should follow this
convention.)

-- 
Romain FRANCOISE <romain@orebokech.com> | I get secrets at night, but
it's a miracle -- http://orebokech.com/ | they don't stay. I get
                                        | secrets at night, but they go
                                        | away.