From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Christopher Dimech Newsgroups: gmane.emacs.help Subject: Re: Defun Self Documentation Date: Thu, 5 Nov 2020 16:55:54 +0100 Message-ID: References: <20201105154537.GA24492@tuxteam.de> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="35682"; mail-complaints-to="usenet@ciao.gmane.io" Cc: help-gnu-emacs@gnu.org To: tomas@tuxteam.de Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Thu Nov 05 16:58:15 2020 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1kaheQ-0009BT-Tp for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 05 Nov 2020 16:58:14 +0100 Original-Received: from localhost ([::1]:57486 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kaheP-0004jK-5b for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 05 Nov 2020 10:58:13 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36040) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kahcT-0004iJ-R3 for help-gnu-emacs@gnu.org; Thu, 05 Nov 2020 10:56:14 -0500 Original-Received: from mout.gmx.net ([212.227.15.18]:51279) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kahcM-0001fr-Kp for help-gnu-emacs@gnu.org; Thu, 05 Nov 2020 10:56:13 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1604591754; bh=vE3xeS05zQf9T5lvx0dKZri7QcIUjJTQq8RfA+sdCpQ=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=hgLAhcx2L+wF5K7ockl19Wav16sBHt2xTyE23fLXNE3XgJ4pAUxYHa+0gC5El+adn gzSA/rxzwycOkNDmMgl4s1SD4ByhN3W68a+8ne7W3/KFCTdZEbfovTmbFA8O4jh4mC BHLqbPKjDz4LMdp4lvy7Ykz2YFYc+fJ+LzM746ek= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from [213.165.168.94] ([213.165.168.94]) by web-mail.gmx.net (3c-app-mailcom-bs14.server.lan [172.19.170.182]) (via HTTP); Thu, 5 Nov 2020 16:55:54 +0100 Importance: normal Sensitivity: Normal In-Reply-To: <20201105154537.GA24492@tuxteam.de> X-UI-Message-Type: mail X-Priority: 3 X-Provags-ID: V03:K1:k54/8QTqmdALXIolgCyqo0KkQIAzSmo3c/WhaKvEgXvKxfx8UibHczcPD4SDchvPttKSp Nr/ptgDEnbJq5q5RFlRtmN8CVbFphvZrQ56MmQn8ri0P5Dxn4t0g+wUWfCCoumRfQT/nOa7bbMnW IoYC/OTIfBFOeYEiHOHa6GwWl5DQyqp1OISYWgH2DL99Mei4AjZ/w77ftk/q+UowmMZmxI56h6P9 qk1ittEQZmPmJVJm7jo9NAHIwoqOY8R7vrZ8zl0V9QFFpfmxkGoXIvK79jPJvYJmZNV3QbCSogWz do= X-UI-Out-Filterresults: notjunk:1;V03:K0:jJAdYjfzSaQ=:OyHZoNDeYPmZYIkDzRKZ82 Zj1bgIIqz0DkMLfbz0onXVTSWhBcQcCqR50ToLhtlKthv0ALnTVQwpS0JNG6lcAVsZFp+cVmm 5iDXp9ud6NjLV7B7pBOvhlRynIIrZdzh9uVmOclqZ4gmzIjYD9H77zCdv9uQKnQaguXr4VZrG BR6ATbKAiQDveNHy0/9fDhROCYbzcMgZUUjQpuTSG+APLau9iNYT22mD27tS+3yX9xQsHCrG3 owOI7e5UwSCHALXIDKSv6VAhefZj/w1eM42W0jv7nIfE9ZpIvtPG9u03KtDq43FbpfE+PdxFu Q8zk1M5nK6MrLwBOUYjxQMb22xzeu+2NC0A6KcSZMW8U1hqoTqXVay3vXB/D2VzWEfMj2WudM vyvpz3dS1EWwa1r0GwA49vZ7UzMZYygUR4tZJgFnMq2ZF4AWu2G3JeprvecaLTjE9pOtLztSP XxnT4WgZJrzMTkze/rWTZOB6+iRkPpS78fu3PnafOIKWbYboukcIL/PAWoVNQ4OYf6yYfXUZW lq+FCGq9R7t179jURz4xWVUUseMi1+2PZnMidzo7pzZK0wBviZD0AQXQXB6jZpJiX8NdynEjG DBjWdI89oAHMQ= Received-SPF: pass client-ip=212.227.15.18; envelope-from=dimech@gmx.com; helo=mout.gmx.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/11/05 10:56:04 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:125019 Archived-At: Don't people find it tough to immediately figure out which bracket closes what? But if readers will thank me, I would certainly comply. I come fro= m the C-Language as is evident. > Sent: Thursday, November 05, 2020 at 4:45 PM > From: tomas@tuxteam.de > To: help-gnu-emacs@gnu.org > Subject: Re: Defun Self Documentation > > On Thu, Nov 05, 2020 at 04:16:09PM +0100, Christopher Dimech wrote: > > > > When using defun, can one include a Self Documenting string or is > > Self-Documentation only applicable for interactive functions? > > > > (defun Gdn () > > "Description" > > Body ... > > ) > > No need to be interactive. > > Minor nit: convention in Lisp is > > (defun Gdn () > "Description" > Body ... ) > > i.e. closing parens don't get a line of their own. Readers will > thank you :) > > Cheers > - t >