From: Drew Adams <drew.adams@oracle.com>
To: Nicolas Petton <nicolas@petton.fr>, Eli Zaretskii <eliz@gnu.org>,
Philipp Stephani <p.stephani2@gmail.com>
Cc: emacs-devel@gnu.org
Subject: RE: Making DOC argument of define-minor-mode optional
Date: Wed, 23 Nov 2016 08:35:05 -0800 (PST) [thread overview]
Message-ID: <41b59c33-1be1-440e-a9b1-efb97c6e14a8@default> (raw)
In-Reply-To: <87lgwaxk3z.fsf@petton.fr>
> >> the docstring created by define-minor-mode with nil DOC is useful
> >> and often better than what users write.
> >> Should DOC therefore be optional?
> >
> > Not sure we would like to educate Lisp programmers to stop
> > thinking about good doc strings.
>
> I agree.
Me too. And definers of user-facing things, such as
defcustom and defface, do require DOC. Other definers,
such as defconst and defvar, do not require it.
On the other hand, OP raises a real issue, I think.
I'd be in favor of (somehow) automatically having the
definer-provided DOC be augmented by a link that shows
the generic `define-minor-mode' doc, or similar.
IOW:
1. Definers should need to provide a DOC string (even if
they can fake it with "", which is not encouraged).
2. Users of the mode should have access to the generic
information also. It should be sufficient that the
DOC in the definition provides mode-specific information.
It should not need to tell users general things about
using a minor mode.
next prev parent reply other threads:[~2016-11-23 16:35 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-23 10:04 Making DOC argument of define-minor-mode optional Philipp Stephani
2016-11-23 15:50 ` Eli Zaretskii
2016-11-23 15:59 ` Nicolas Petton
2016-11-23 16:35 ` Drew Adams [this message]
2016-11-27 21:13 ` Philipp Stephani
2016-12-28 17:25 ` Philipp Stephani
2016-12-29 0:44 ` Drew Adams
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=41b59c33-1be1-440e-a9b1-efb97c6e14a8@default \
--to=drew.adams@oracle.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=nicolas@petton.fr \
--cc=p.stephani2@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 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).