[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Opinions on look of documentation
From: |
John W. Eaton |
Subject: |
Re: Opinions on look of documentation |
Date: |
Fri, 11 Dec 2015 16:12:02 -0500 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Icedove/31.7.0 |
On 12/11/2015 01:57 PM, Rik wrote:
The simplest change in the code is to blank out the type field. After that
change, 'help ls' looks like
-- : ls
-- : ls FILENAMES
-- : ls OPTIONS
-- : ls OPTIONS FILENAMES
-- : LIST = ls (...)
List directory contents.
I think the ":" looks a little funny there. I would like it better if
if it only displayed the leading "--", like this:
-- ls
-- ls FILENAMES
...
though even that might be confusing to some people. I don't konw.
If it is not possible to configure makeinfo to display this way, I guess
we could fix that with a sed filter.
Also, why the extra space before "ls..." vs. "LIST..."? Where is that
coming from?
Alternatively, we
could fall back to using @deftypefun which would set the type field to
"Function".
Doesn't that also put the "[Function]" tag in the PDF file?
jwe