From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Newsgroups: gmane.emacs.help Subject: Re: Defun Self Documentation Date: Thu, 5 Nov 2020 16:45:38 +0100 Message-ID: <20201105154537.GA24492@tuxteam.de> References: Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="LZvS9be/3tNcYl/X" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="26729"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/1.5.21 (2010-09-15) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Thu Nov 05 16:47:46 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 1kahUH-0006lW-Hh for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 05 Nov 2020 16:47:45 +0100 Original-Received: from localhost ([::1]:60496 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kahUG-0002Cu-HB for geh-help-gnu-emacs@m.gmane-mx.org; Thu, 05 Nov 2020 10:47:44 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33438) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kahSY-0001oq-J2 for help-gnu-emacs@gnu.org; Thu, 05 Nov 2020 10:45:58 -0500 Original-Received: from mail.tuxteam.de ([5.199.139.25]:53717) by eggs.gnu.org with esmtps (TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.90_1) (envelope-from ) id 1kahSW-00065P-A5 for help-gnu-emacs@gnu.org; Thu, 05 Nov 2020 10:45:58 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tuxteam.de; s=mail; h=From:In-Reply-To:Content-Type:MIME-Version:References:Message-ID:Subject:To:Date; bh=WXpjnrw/doazfLVWbYBtEScKmRXTlHik595TdJWfX1w=; b=F2bDSbdJKlW9re7Xt7+xHeqvB3pz2jbmabY+UKC1p0DNenQVbiygCryLiBOLsxR82ES4iOeCJljq96mN8m3+3rYyVSJ4MUlpFjSh7rAxn9OB6m3rTE4ooXOlxCaoCCsrhlhAZ7XHBfT8ywgAnXb0s/9gi71ZjH8uxJtCq220xNkJDMgtNkHCMsn2CUtEmWYEZV1U8Dp7mhdqauNl1JFLkSIe8e0TZZcM3R+054qAKTYzLLthP7qFw114CZ8ivsNQmV75pag4L0FC2UR4YKZdFMcfPLIeqDZa3TvpGQIpX7z4rlPJJ9VyXZF++0F/+4Uf6LqFwhAQ814X2627eUvkgg==; Original-Received: from tomas by mail.tuxteam.de with local (Exim 4.80) (envelope-from ) id 1kahSE-0006PA-1k for help-gnu-emacs@gnu.org; Thu, 05 Nov 2020 16:45:38 +0100 Content-Disposition: inline In-Reply-To: Received-SPF: pass client-ip=5.199.139.25; envelope-from=tomas@tuxteam.de; helo=mail.tuxteam.de X-detected-operating-system: by eggs.gnu.org: First seen = 2020/11/05 10:45:48 X-ACL-Warn: Detected OS = Linux 3.1-3.10 [fuzzy] X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, 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:125017 Archived-At: --LZvS9be/3tNcYl/X Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Nov 05, 2020 at 04:16:09PM +0100, Christopher Dimech wrote: >=20 > When using defun, can one include a Self Documenting string or is > Self-Documentation only applicable for interactive functions? >=20 > (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 --LZvS9be/3tNcYl/X Content-Type: application/pgp-signature; name="signature.asc" Content-Description: Digital signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.12 (GNU/Linux) iEYEARECAAYFAl+kHiEACgkQBcgs9XrR2kbbSACcCJR4ngaycBBJeGkq5KLlE4ev 52EAnRiq1gFmaqogPFGTP7jSgHyMdTX4 =0AbP -----END PGP SIGNATURE----- --LZvS9be/3tNcYl/X--