From: wjf103@york.ac.uk (Wez Furlong)
To: zsh-workers@math.gatech.edu
Subject: Re: helpfiles
Date: Fri, 7 Nov 1997 13:07:29 +0000 [thread overview]
Message-ID: <199711071307.NAA11796@tower.york.ac.uk> (raw)
In-Reply-To: Andrej Borsenkow <borsenkow.msk@sni.de> "Re: helpfiles" (Nov 7, 3:30pm)
On Nov 7, 3:30pm, Andrej Borsenkow wrote:
: What abot including these help files in program itself? (That is, for
: every command add string with description). These way it is possible
: provide help for user-defined commands (from loadable modules). The manual
: page for zshbuiltins itself could then be generated from these
: descriptions; this way, if some module is added to distribution, it will
: be automatically included.
How about a compile time option as to whether these get put in the
binary itself?
Also, it would be nicer/easier to maintain documentation if it were kept
in the source itself (c.f. AmigaOS and it's AutoDocs) - the
documentation for a module (being a function, builtin or whatever; not
necessarily a zsh module) is kept in the source in the form of special
comments, with headings similar to those of man pages:
/****** nameofmodulegroup/nameofspecificpartofmodule
SYNOPSIS
DESCRIPTON
ETC..
******************************
*/
I know that this does clutter the source somewhat, but it is far easier
for the programmer to quickly edit the documentation if it is in the
same file as that he is editing at the time, especially if that
documentation is within a few lines of the code he has just changed.
Just a suggestion.
--
Wez - Electronics Undergraduate at the University of York
URL : http://www.twinklestar.demon.co.uk/
Insult Of The Day: Thou bawdy dismal-dreaming pignut!
next parent reply other threads:[~1997-11-07 13:11 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <borsenkow.msk@sni.de>
1997-11-07 13:07 ` Wez Furlong [this message]
1997-11-07 9:14 helpfiles Peter Stephenson
1997-11-07 12:30 ` helpfiles Andrej Borsenkow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=199711071307.NAA11796@tower.york.ac.uk \
--to=wjf103@york.ac.uk \
--cc=zsh-workers@math.gatech.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).