all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Xue Fuqiao <xfq.free@gmail.com>
Cc: ttn@gnu.org, emacs-devel@gnu.org
Subject: RE: Changes in revision 114466
Date: Mon, 30 Sep 2013 09:38:06 -0700 (PDT)	[thread overview]
Message-ID: <c6294462-e7c7-4122-8bcb-d7a03f15c6b2@default> (raw)
In-Reply-To: <<83k3hye2uq.fsf@gnu.org>>

> > IMO every user option and every command needs documentation.
> 
> First, the original issue that started this thread was about changes
> in the ELisp manual, 

That may be.  But the statement that every user option and command needs
documentation does not speak about manuals.  In any case, that's how I
understood it: these things need documentation.

Which they (and others, IMHO) do: doc strings.

> The only serious problem with the doc strings is that they lack the
> "glue": the kind of overview and background material that we usually
> put in the manual when we describe a significant topic.

A manual is exactly where such glue (overview, background, context,
relations) belongs.

> So what would probably be a good idea in order to improve the visibility
> of those commands and options that are not in the manual is the following
> measures:

I disagree.  We don't need such an additional manual.

Either (a) something should be documented in the manual or
(b) it does not to be documented there and doc strings suffice.

By "doc strings" (plural), I include the possibility that one doc string
refers to (links to) another.

What we might want/need (I have proposed this several times, and so have
others) is linking from doc strings to the manuals.  That would indeed be
useful, IMO.  It would provide missing glue, as you put it.

There are a very few doc strings, IIRC, that actually do this.  It would
be good to generalize it, or at least make use of it more.



  parent reply	other threads:[~2013-09-30 16:38 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <mailman.53349.1380335551.10747.emacs-diffs@gnu.org>
2013-09-28  7:46 ` Changes in revision 114466 Eli Zaretskii
2013-09-28 22:30   ` Xue Fuqiao
2013-09-29  2:36     ` Eli Zaretskii
2013-09-29  7:24       ` Thien-Thi Nguyen
2013-09-30  4:55         ` Xue Fuqiao
2013-09-30  5:21           ` Drew Adams
2013-09-30 10:29             ` Stephen Berman
2013-09-30 15:05               ` Drew Adams
2013-09-30 15:52                 ` Thien-Thi Nguyen
2013-10-01  2:11                 ` Stephen J. Turnbull
2013-09-30 15:42               ` Eli Zaretskii
2013-09-30 11:47             ` Andreas Röhler
2013-09-30 15:38           ` Eli Zaretskii
     [not found]           ` <<83k3hye2uq.fsf@gnu.org>
2013-09-30 16:38             ` Drew Adams [this message]
2013-10-01  3:40               ` Xue Fuqiao
2013-10-01  4:57                 ` Stephen J. Turnbull
2013-10-01  5:15                   ` Drew Adams
2013-10-01  5:27                     ` Drew Adams
2013-10-01  6:11                     ` Stephen J. Turnbull
2013-10-01  7:44                       ` Drew Adams
2013-10-01  8:29                         ` Stephen J. Turnbull

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=c6294462-e7c7-4122-8bcb-d7a03f15c6b2@default \
    --to=drew.adams@oracle.com \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=ttn@gnu.org \
    --cc=xfq.free@gmail.com \
    /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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.