octave-maintainers
[Top][All Lists]
Advanced

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

Re: documentation style question


From: Michael Godfrey
Subject: Re: documentation style question
Date: Fri, 12 Sep 2014 17:07:55 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.1.0


On 09/12/2014 04:57 PM, John W. Eaton wrote:
On 09/12/2014 11:50 AM, Michael Godfrey wrote:
Would something like:

## @deftypefn  {Command} {} grid
## @deftypefnx {Command} {} grid [ on | off ]
## @deftypefnx {Command} {} grid minor [ on | off ]
## @deftypefnx {Function File} {} grid (@var{hax}, @dots{})

(and if there is a default in the [  ] list indicate it with {x} as is
done in the display of graphics figure properties )

to make things more compact?

Yes, but then people get confused about the meaning of the "[", "|", and "]" characters because they are part of Octave's syntax.

jwe

Well, maybe. Is there a better notation for alternatives? Or, maybe a one line explanation like: alternatives are shown by: [ on | off ] with {} indicating default.

Michael




reply via email to

[Prev in Thread] Current Thread [Next in Thread]