From: Dieter Wilhelm <dieter@duenenhof-wilhelm.de>
Subject: No return value in doc string
Date: Mon, 24 Apr 2006 02:27:05 +0200 [thread overview]
Message-ID: <87y7xv3jja.fsf@hans.local.net> (raw)
Hi
Is there any policy for the documentation string of the return value?
The Elisp programming guidelines just mention that the documentation
string for functions should answer the question "What does this
function do?". So I'd consider leaving out the return value in a doc
string of an interactive function a failure (please have a look at
`next-line' `previous-line' and `make-frame').
Should I report this as bugs or is this a bit over the top?
--
Best wishes
Dieter Wilhelm
next reply other threads:[~2006-04-24 0:27 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-04-24 0:27 Dieter Wilhelm [this message]
2006-04-26 17:34 ` No return value in doc string Eli Zaretskii
2006-04-27 1:16 ` Dieter Wilhelm
[not found] <mailman.965.1146057882.9609.help-gnu-emacs@gnu.org>
2006-04-27 20:07 ` Stefan Monnier
2006-04-29 10:01 ` Dieter Wilhelm
[not found] ` <mailman.1122.1146330818.9609.help-gnu-emacs@gnu.org>
2006-04-29 21:55 ` Miles Bader
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=87y7xv3jja.fsf@hans.local.net \
--to=dieter@duenenhof-wilhelm.de \
/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.