From: Alex Schroeder <alex@emacswiki.org>
Subject: Re: INFO on add-ons
Date: Thu, 05 Sep 2002 00:40:15 +0200 [thread overview]
Message-ID: <87d6rttm40.fsf@emacswiki.org> (raw)
In-Reply-To: <buo4rd6mt2e.fsf@mcspd15.ucom.lsi.nec.co.jp> (Miles Bader's message of "04 Sep 2002 10:39:37 +0900")
Miles Bader <miles@lsi.nec.co.jp> writes:
> Alex Schroeder <alex@emacswiki.org> writes:
>> Only if doc strings and commentaries (readable via package finder in
>> Emacs, perhaps there needs to be a better interface?) fail, should we
>> need to write Info. As I said this is for newbies, and pulling stuff
>> together.
>
> I use doc-strings more often in my daily work, but I think info files
> are very useful for getting a broader view of a package. I don't think
> we should avoid writing manual entries just because there are
> doc-strings
Totally correct. That is what I meant by "pulling stuff" together.
The idea of writing a texinfo page for every package, however, is
overkill. We only need a texinfo page when a broader view of a
package is required. In sql.el, for example, there is a sql-help
defun, and all the entry points have enough information to get you
started. And it is not so complex as to merit a manual.
I am not saying a manual is useless. I am saying that requiring a
manual at all times is useless.
Alex.
next prev parent reply other threads:[~2002-09-04 22:40 UTC|newest]
Thread overview: 79+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <3D728E82.8000808@cox.net>
2002-09-01 22:16 ` INFO on add-ons Alex Schroeder
2002-09-02 23:49 ` David A. Cobb
[not found] ` <3D73F919.5010706@cox.net>
2002-09-03 22:56 ` Alex Schroeder
2002-09-04 0:48 ` Alex Schroeder
2002-09-04 1:39 ` Miles Bader
2002-09-04 4:47 ` Eli Zaretskii
2002-09-04 5:02 ` Miles Bader
2002-09-04 5:06 ` Eli Zaretskii
2002-09-04 5:14 ` Miles Bader
2002-09-04 13:20 ` Eli Zaretskii
2002-09-04 13:34 ` Miles Bader
2002-09-05 4:46 ` Eli Zaretskii
2002-09-05 12:09 ` Valdis.Kletnieks
2002-09-05 14:52 ` Robert J. Chassell
2002-09-04 22:40 ` Alex Schroeder [this message]
2002-09-05 2:46 ` Richard Stallman
2002-09-07 7:44 ` Pavel Janík
2002-09-04 4:44 ` Eli Zaretskii
2002-09-04 12:13 ` Robert J. Chassell
2002-09-04 4:42 ` Eli Zaretskii
2002-09-02 1:08 ` Stephen J. Turnbull
2002-09-02 14:53 ` Richard Stallman
2002-09-02 23:59 ` David A. Cobb
[not found] ` <87ptvxxkoj.fsf@tleepslib.sk.tsukuba.ac.jp>
2002-09-02 1:36 ` Miles Bader
[not found] ` <buok7m5jhpm.fsf@mcspd15.ucom.lsi.nec.co.jp>
2002-09-02 4:51 ` Stephen J. Turnbull
[not found] ` <87fzwtxad9.fsf@tleepslib.sk.tsukuba.ac.jp>
2002-09-02 5:04 ` Miles Bader
[not found] ` <buoelcdj82q.fsf@mcspd15.ucom.lsi.nec.co.jp>
2002-09-02 6:03 ` Stephen J. Turnbull
2002-09-02 23:47 ` David A. Cobb
[not found] ` <3D73F89D.2070106@cox.net>
2002-09-03 4:16 ` "Extreme Documentation" [was: INFO on add-ons] Stephen J. Turnbull
2002-09-03 15:49 ` David A. Cobb
2002-09-03 19:05 ` Thien-Thi Nguyen
2002-09-04 3:51 ` Stephen J. Turnbull
2002-09-04 5:58 ` Thien-Thi Nguyen
2002-09-03 13:26 ` INFO on add-ons Richard Stallman
2002-09-03 15:43 ` Stephen J. Turnbull
2002-09-03 16:30 ` Robert J. Chassell
2002-09-03 17:33 ` Henrik Enberg
2002-09-03 17:58 ` Miles Bader
2002-09-03 20:54 ` Kai Großjohann
2002-09-03 20:54 ` Kai Großjohann
2002-09-02 23:40 ` David A. Cobb
[not found] ` <3D73F6D1.7010002@cox.net>
2002-09-03 4:42 ` Stephen J. Turnbull
2002-09-03 15:39 ` David A. Cobb
2002-09-03 16:23 ` Robert J. Chassell
2002-09-03 22:23 ` David A. Cobb
2002-09-04 1:18 ` Miles Bader
2002-09-04 3:39 ` Stephen J. Turnbull
2002-09-04 3:46 ` Miles Bader
2002-09-04 7:23 ` Stephen J. Turnbull
2002-09-05 2:17 ` Karl Eichwalder
2002-09-04 14:38 ` Robert J. Chassell
2002-09-04 17:42 ` Ville Skyttä
2002-09-04 22:14 ` Robert J. Chassell
2002-09-05 2:53 ` Stephen J. Turnbull
2002-09-05 13:37 ` Robert J. Chassell
2002-09-06 2:40 ` Stephen J. Turnbull
2002-09-06 12:18 ` Robert J. Chassell
2002-09-06 13:30 ` Miles Bader
2002-09-06 20:03 ` Richard Stallman
2002-09-05 13:54 ` Robert J. Chassell
2002-09-05 20:16 ` Ville Skyttä
2002-09-04 15:49 ` Stefan Monnier
2002-09-04 17:12 ` Robert J. Chassell
2002-09-04 18:22 ` Ville Skyttä
2002-09-05 1:48 ` Miles Bader
2002-09-05 2:32 ` Karl Eichwalder
2002-09-05 4:51 ` Eli Zaretskii
2002-09-05 6:00 ` Karl Eichwalder
2002-09-05 13:25 ` Robert J. Chassell
2002-09-05 4:48 ` Eli Zaretskii
2002-09-05 4:22 ` Stephen J. Turnbull
2002-09-05 18:02 ` Richard Stallman
2002-09-06 1:19 ` Miles Bader
2002-09-06 20:03 ` Richard Stallman
2002-09-04 4:44 ` Eli Zaretskii
2002-09-04 12:29 ` Robert J. Chassell
2002-09-05 2:46 ` Richard Stallman
2002-09-02 23:22 ` David A. Cobb
2002-09-01 22:02 David A. Cobb
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87d6rttm40.fsf@emacswiki.org \
--to=alex@emacswiki.org \
/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.savannah.gnu.org/cgit/emacs.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).