From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jean Louis Newsgroups: gmane.emacs.help Subject: Re: [External] : Supplying DOC string in a `defun' using `defvar' Date: Wed, 2 Jun 2021 21:59:34 +0300 Message-ID: References: <87r1hlw6pn.fsf@web.de> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19811"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/2.0.7+183 (3d24855) (2021-05-28) Cc: Christopher Dimech , "help-gnu-emacs@gnu.org" To: Stefan Monnier Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Wed Jun 02 21:04:22 2021 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 1loWAA-0004vC-CC for geh-help-gnu-emacs@m.gmane-mx.org; Wed, 02 Jun 2021 21:04:22 +0200 Original-Received: from localhost ([::1]:59490 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1loWA9-0003qc-Be for geh-help-gnu-emacs@m.gmane-mx.org; Wed, 02 Jun 2021 15:04:21 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34176) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1loW9Z-0003ox-AS for help-gnu-emacs@gnu.org; Wed, 02 Jun 2021 15:03:45 -0400 Original-Received: from stw1.rcdrun.com ([217.170.207.13]:57599) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1loW9X-0004iI-BV for help-gnu-emacs@gnu.org; Wed, 02 Jun 2021 15:03:45 -0400 Original-Received: from localhost ([::ffff:197.157.0.35]) (AUTH: PLAIN admin, TLS: TLS1.3,256bits,ECDHE_RSA_AES_256_GCM_SHA384) by stw1.rcdrun.com with ESMTPSA id 00000000000AE2D9.0000000060B7D60A.00004960; Wed, 02 Jun 2021 12:03:36 -0700 Mail-Followup-To: Stefan Monnier , Drew Adams , Christopher Dimech , "help-gnu-emacs@gnu.org" Content-Disposition: inline In-Reply-To: Received-SPF: pass client-ip=217.170.207.13; envelope-from=bugs@gnu.support; helo=stw1.rcdrun.com X-Spam_score_int: -3 X-Spam_score: -0.4 X-Spam_bar: / X-Spam_report: (-0.4 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_SORBS_WEB=1.5, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=no 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:130511 Archived-At: * Stefan Monnier [2021-06-02 21:37]: > Drew Adams [2021-06-02 15:53:31] wrote: > >> > From my point of view, the docstring should have > >> > nothing to do with either dynamic or lexical binding. > >> No, but > > I guess (hope) that your "No, but" really means "Yes, > > but", and that you agree that it _should_ indeed have > > nothing to do with dynamic or lexical binding. > >> it's a new language feature, so it makes sense that > >> you need to use the new dialect for it be available. > > I don't see how that makes sense at all. It doesn't > > follow logically that every "new language feature" > > must work _only_ with the lexical binding dialect > > turned ON. > > Indeed it doesn't mean it would be bad to support > (:documentation ) in the dynbound case. But it's argument for not > bothering to do so. That feature is kind of hidden, as the only place where it is mentioned in the manual is at (elisp) Generic Functions -- Macro: cl-defgeneric name arguments [documentation] [options-and-methods...] &rest body This macro defines a generic function with the specified NAME and ARGUMENTS. If BODY is present, it provides the default implementation. If DOCUMENTATION is present (it should always be), it specifies the documentation string for the generic function, in the form ‘(:documentation DOCSTRING)’. The optional OPTIONS-AND-METHODS can be one of the following forms: So it is not official feature, as `defun' and `cl-defgeneric' are not same and there is nothing about it explained in `defun' doc-string -- Jean Take action in Free Software Foundation campaigns: https://www.fsf.org/campaigns Sign an open letter in support of Richard M. Stallman https://stallmansupport.org/