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

Re: Call for info writers


It is fine but very dry here in Tokyo.

>>>>> In [emacs-w3m : No.04527]
>>>>>	Romain FRANCOISE <romain@orebokech.com> wrote:

> The snow began to fall tonight, so my other plans were cancelled.  I
> have therefore had time to proofread the nodes by YAMATO-san and this
> node about Gnus, it is excellent work!


> Please keep these guidelines in mind, though:

> - write at the present tense.  No future, no past tense.
> - write actively, as in "You can do this" or "We have added that"

Ok.  I am looking them over again.

;; Tense of Japanese is very ambiguous, so it is cut out for
;; time-traveling novels. ;-)

> - put @findex and @vindex at the exact place where the function is
>   described in a node, i.e. in the @table @kbd and not at the top level
>   of the node.  And put it only once.  :)

> It makes more easily readable documentation.

I see.  Let's do in this way?  When there's a detailed
explanation of a variable in a section, we put a @vindex there.
Otherwise, we put a @vindex in the "Customizable Options"
section.  We do the same for @findex.

> My diff is ~420 lines long right now since I had to rewrite some
> paragraphs completely, I even had difficulty understanding what the
> author meant at some places.  I also tried to follow Yamaoka-san's style
> and be a little less rigorous, I like funny documentation too.  I hope
> it's not a problem.  ;)

> I'll send this patch tomorrow along with the nodes I promised.

Katsumi Yamaoka <yamaoka@jpl.org>