From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Dieter Wilhelm Newsgroups: gmane.emacs.help Subject: No return value in doc string Date: Mon, 24 Apr 2006 02:27:05 +0200 Message-ID: <87y7xv3jja.fsf@hans.local.net> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1146057931 24405 80.91.229.2 (26 Apr 2006 13:25:31 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Wed, 26 Apr 2006 13:25:31 +0000 (UTC) Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Wed Apr 26 15:25:27 2006 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1FYk13-0002Wy-87 for geh-help-gnu-emacs@m.gmane.org; Wed, 26 Apr 2006 15:25:13 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1FYk12-0004hs-Gh for geh-help-gnu-emacs@m.gmane.org; Wed, 26 Apr 2006 09:25:12 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1FYhpF-0008FJ-8x for help-gnu-emacs@gnu.org; Wed, 26 Apr 2006 07:04:53 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1FYhpE-0008El-Cy for help-gnu-emacs@gnu.org; Wed, 26 Apr 2006 07:04:52 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1FYhpE-0008Eg-3s for help-gnu-emacs@gnu.org; Wed, 26 Apr 2006 07:04:52 -0400 Original-Received: from [212.227.126.171] (helo=moutng.kundenserver.de) by monty-python.gnu.org with esmtp (Exim 4.52) id 1FYhrt-0004zN-1d for help-gnu-emacs@gnu.org; Wed, 26 Apr 2006 07:07:38 -0400 Original-Received: from [84.167.2.169] (helo=duenenhof-wilhelm.de) by mrelayeu.kundenserver.de (node=mrelayeu9) with ESMTP (Nemesis), id 0ML2xA-1FYhp83ZhM-0000bL; Wed, 26 Apr 2006 13:04:47 +0200 Original-Received: by duenenhof-wilhelm.de (Postfix, from userid 1000) id 802E148102; Tue, 25 Apr 2006 21:39:51 +0200 (CEST) Resent-To: help-gnu-emacs@gnu.org Resent-From: Dieter Wilhelm Resent-Date: Tue, 25 Apr 2006 21:39:51 +0200 Resent-Message-ID: <87odyp30mw.fsf@hans.local.net> X-From-Line: nobody Mon Apr 24 02:27:05 2006 Original-To: help-gnu-emacs@gnu.org User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/22.0.50 (gnu/linux) Original-Lines: 15 X-Provags-ID: kundenserver.de abuse@kundenserver.de login:d7ab225b98a136e1c2910381f940ecb9 Resent-Date: Wed, 26 Apr 2006 07:04:52 -0400 X-Mailman-Approved-At: Wed, 26 Apr 2006 09:24:38 -0400 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.help:34671 Archived-At: 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