From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#54732: 29.0.50; New `function-documentation` Date: Wed, 06 Apr 2022 11:29:46 +0200 Message-ID: <87fsmqef05.fsf@gnus.org> References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="29850"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: 54732@debbugs.gnu.org To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Apr 06 11:31:00 2022 Return-path: Envelope-to: geb-bug-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 1nc20B-0007X9-WE for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 06 Apr 2022 11:31:00 +0200 Original-Received: from localhost ([::1]:41526 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nc20A-0006o8-JL for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 06 Apr 2022 05:30:58 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:40178) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nc1zH-0006lq-UM for bug-gnu-emacs@gnu.org; Wed, 06 Apr 2022 05:30:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:34810) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nc1zG-0004Rc-5q for bug-gnu-emacs@gnu.org; Wed, 06 Apr 2022 05:30:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nc1zF-0000zz-RR for bug-gnu-emacs@gnu.org; Wed, 06 Apr 2022 05:30:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 06 Apr 2022 09:30:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 54732 X-GNU-PR-Package: emacs Original-Received: via spool by 54732-submit@debbugs.gnu.org id=B54732.16492373993811 (code B ref 54732); Wed, 06 Apr 2022 09:30:01 +0000 Original-Received: (at 54732) by debbugs.gnu.org; 6 Apr 2022 09:29:59 +0000 Original-Received: from localhost ([127.0.0.1]:56940 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nc1zD-0000zO-BC for submit@debbugs.gnu.org; Wed, 06 Apr 2022 05:29:59 -0400 Original-Received: from quimby.gnus.org ([95.216.78.240]:35090) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nc1zC-0000z8-1E for 54732@debbugs.gnu.org; Wed, 06 Apr 2022 05:29:58 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org; s=20200322; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date: References:Subject:Cc:To:From:Sender:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=sYuTAT8uHIF0+AGxvfcYGOqEJytAeeOnIdvpakluPg4=; b=I4uFlK2Rj0Z+8E90cLQps3mwU4 sE7FsIsyF4jpJTWSDH4H/YxDFN03tlrunZ72MzyyfZCdyEG5tDY1zfcjIiuJhx7SXHTmUHi4jNtlH 5Mv9GXcCy8MncMjavy71+CoXYAwHe3ulRWL/sPbVPh5FH7DuWALm5xyYXcXrmq4LJ5gc=; Original-Received: from [84.212.220.105] (helo=xo) by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nc1z1-00019b-SW; Wed, 06 Apr 2022 11:29:50 +0200 In-Reply-To: (Stefan Monnier's message of "Tue, 05 Apr 2022 13:28:31 -0400") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:229478 Archived-At: Stefan Monnier writes: > The patch below lifts this restriction by introducing a new generic > function `function-documentation` to fetch the docstring of a function, > which can then be implemented in various different ways depending on the > OClosure's type. Makes sense to me. Perhaps the doc string should also say that the reason that `function-documentation' exists is to allow specialisation, and that it should (probably) never be called from code directly, instead of just saying that `documentation' is preferable: + "Extract the raw docstring info from FUNCTION. +FUNCTION is expected to be a function value rather than, say, a mere symbol. +It is usually preferable to call `documentation' which will call this +function as needed." -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no