From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: carlmarcos--- via Users list for the GNU Emacs text editor Newsgroups: gmane.emacs.help Subject: Re: Executing function only if another function is defined Date: Mon, 25 Jul 2022 13:30:58 +0200 (CEST) Message-ID: References: <87czduhsxe.fsf@dataswamp.org> <877d41h2ap.fsf@dataswamp.org> Reply-To: carlmarcos@tutanota.com 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="37025"; mail-complaints-to="usenet@ciao.gmane.io" Cc: help-gnu-emacs@gnu.org To: Emanuel Berg Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Mon Jul 25 13:33:10 2022 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 1oFwKj-0009Oz-Kp for geh-help-gnu-emacs@m.gmane-mx.org; Mon, 25 Jul 2022 13:33:09 +0200 Original-Received: from localhost ([::1]:49006 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oFwKi-0003Q5-4e for geh-help-gnu-emacs@m.gmane-mx.org; Mon, 25 Jul 2022 07:33:08 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37964) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oFwIk-0002ih-Bj for help-gnu-emacs@gnu.org; Mon, 25 Jul 2022 07:31:08 -0400 Original-Received: from w1.tutanota.de ([81.3.6.162]:49816) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oFwIe-0005zt-PY for help-gnu-emacs@gnu.org; Mon, 25 Jul 2022 07:31:06 -0400 Original-Received: from w3.tutanota.de (unknown [192.168.1.164]) by w1.tutanota.de (Postfix) with ESMTP id B7BF1FBF397; Mon, 25 Jul 2022 11:30:58 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1658748658; s=s1; d=tutanota.com; h=From:From:To:To:Subject:Subject:Content-Description:Content-ID:Content-Type:Content-Type:Content-Transfer-Encoding:Content-Transfer-Encoding:Cc:Cc:Date:Date:In-Reply-To:In-Reply-To:MIME-Version:MIME-Version:Message-ID:Message-ID:Reply-To:References:References:Sender; bh=yFOdKulKL7vfseHXmEpJAQwLOE5hkT7lpTA9PBTJyCw=; b=dsiod1y7wPTzB/hML9N2kQQsVmVYu89l4skCbR4Opsw6XxIz+NheGMy23GKGuxxC lTwyOKm7YMcvp8FLgJrQnth5kS8/W644R4u/NrlRCyRKLEbkQn/XTcjyjG3wf/wq6J0 EpKsViWbPYz20z8adf2XqVeNFNn/TalV6x0Bd2RjPbP+jnmLsfMQvxExDdcEytDoa2P TRalmOVL4wpYvTUzc5jAzpSRvbhlwDJ9HpnnzwdkC27q6a9hTHd6kMJrLcJl2duy6ru hHu3R7tEbPl3NxrKJkwltqtMuS/dUwhEYAQxgamNp2OuZ+KUNj0xx4Ac1zci1Q55ned TRSHYQaPjg== In-Reply-To: <877d41h2ap.fsf@dataswamp.org> Received-SPF: pass client-ip=81.3.6.162; envelope-from=carlmarcos@tutanota.com; helo=w1.tutanota.de 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_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.29 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:138609 Archived-At: Jul 25, 2022, 11:14 by incal@dataswamp.org: > carlmarcos--- via Users list for the GNU Emacs text editor wrote: > >> (defun docboost (fname doc-boost) >> "Appends a string to the documentation of a function. >> FNAME Name of function >> DOC-BOOST Documentation" >> > > Nice! > > It should be automated to appear like that by default and > automatically, and incorrect docstrings shouldn't not just be > "considered" bugs, they should be bugs ... > What don't you agree with exactly?=C2=A0 The docstring in the function definition would only be a brief description.=C2=A0 If additional informati= on=20 in required, that can be added later, as not to encumber the function with too much text before one can start seeing the implementation. > Well, automated - one would still have to write (and read) > the information manually ... > > However the first argument's name is perhaps not so good as > its inclusion of "name" implies it is a string, better to call > that just "fun" perhaps. And not just for fun ... > > The second argument's isn't so good either as the "boost" > suffix doesn't add anything. Maybe call it "doc" or > "str" instead? > >> (if (functionp fname) >> (put fname 'function-documentation >> (concat (documentation fname t) doc-boost)))) >> > > `when' > >> Is `functionp' appropriate for testing whether `fname' >> was defined? >> > > I don't see why not? > =C2=A0In case there is a superior way to test whether the function was defined. >> Adding a newline before printing the additional >> documentation would be a sensible thing to do. How to do it >> within docboost? >> > > "\n" > > --=20 > underground experts united > https://dataswamp.org/~incal >