all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Dieter Wilhelm <dieter@duenenhof-wilhelm.de>
Cc: help-gnu-emacs@gnu.org
Subject: Re: No return value in doc string
Date: Sat, 29 Apr 2006 12:01:35 +0200	[thread overview]
Message-ID: <87wtd8ya2o.fsf@hans.local.net> (raw)
In-Reply-To: <87fyjy6b09.fsf-monnier+gnu.emacs.help@gnu.org> (Stefan Monnier's message of "Thu, 27 Apr 2006 16:07:46 -0400")

Stefan Monnier <monnier@iro.umontreal.ca> writes:
>
> When called interactively, a function's return value is simply ignored, so
> if a function is expected to only be called interactively, there is no
> reason to document the return value.

Thank you, this is a point I didn't realise.

> Also if the function makes no effort to return anything useful, it
> might be better not to document what the return value happens to be.

But has the disadvantage that the uninitiated and insecure (my
example) may suspect a documentation flaw.

>> Should I report this as bugs or is this a bit over the top?

> Your call,

Eli Z. convinced me already not to waste anybodies time with it.

-- 
Best wishes

     Dieter Wilhelm

  reply	other threads:[~2006-04-29 10:01 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <mailman.965.1146057882.9609.help-gnu-emacs@gnu.org>
2006-04-27 20:07 ` No return value in doc string Stefan Monnier
2006-04-29 10:01   ` Dieter Wilhelm [this message]
     [not found]   ` <mailman.1122.1146330818.9609.help-gnu-emacs@gnu.org>
2006-04-29 21:55     ` Miles Bader
2006-04-24  0:27 Dieter Wilhelm
2006-04-26 17:34 ` Eli Zaretskii
2006-04-27  1:16   ` Dieter Wilhelm

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=87wtd8ya2o.fsf@hans.local.net \
    --to=dieter@duenenhof-wilhelm.de \
    --cc=help-gnu-emacs@gnu.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 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.