unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
* No return value in doc string
@ 2006-04-24  0:27 Dieter Wilhelm
  2006-04-26 17:34 ` Eli Zaretskii
  0 siblings, 1 reply; 6+ messages in thread
From: Dieter Wilhelm @ 2006-04-24  0:27 UTC (permalink / 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

^ permalink raw reply	[flat|nested] 6+ messages in thread
[parent not found: <mailman.965.1146057882.9609.help-gnu-emacs@gnu.org>]

end of thread, other threads:[~2006-04-29 21:55 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-04-24  0:27 No return value in doc string Dieter Wilhelm
2006-04-26 17:34 ` 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

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).