From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Ihor Radchenko Newsgroups: gmane.emacs.bugs Subject: bug#60568: [FR] 30.0.50; Help buffers and function bodies for generated functions Date: Thu, 05 Jan 2023 07:56:11 +0000 Message-ID: <87fscpifdw.fsf@localhost> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="7585"; mail-complaints-to="usenet@ciao.gmane.io" To: 60568@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Jan 05 08:56:14 2023 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 1pDL6j-0001i8-PK for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 05 Jan 2023 08:56:13 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pDL6c-0004h6-Cf; Thu, 05 Jan 2023 02:56:06 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pDL6Y-0004gv-KR for bug-gnu-emacs@gnu.org; Thu, 05 Jan 2023 02:56:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pDL6Y-0002J0-Bz for bug-gnu-emacs@gnu.org; Thu, 05 Jan 2023 02:56:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pDL6Y-0007tT-7J for bug-gnu-emacs@gnu.org; Thu, 05 Jan 2023 02:56:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Ihor Radchenko Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 05 Jan 2023 07:56:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 60568 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.167290535230325 (code B ref -1); Thu, 05 Jan 2023 07:56:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 5 Jan 2023 07:55:52 +0000 Original-Received: from localhost ([127.0.0.1]:50134 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pDL6N-0007t2-GN for submit@debbugs.gnu.org; Thu, 05 Jan 2023 02:55:51 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:41198) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pDL6L-0007st-67 for submit@debbugs.gnu.org; Thu, 05 Jan 2023 02:55:49 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pDL6K-0004gL-KZ for bug-gnu-emacs@gnu.org; Thu, 05 Jan 2023 02:55:48 -0500 Original-Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pDL6F-0002Fq-Jf for bug-gnu-emacs@gnu.org; Thu, 05 Jan 2023 02:55:48 -0500 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 95F382403D8 for ; Thu, 5 Jan 2023 08:55:41 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1672905341; bh=nd61Xaa4ZJcvhBubVWxsBsugVSOZJQJNrDY64moDqYQ=; h=From:To:Subject:Date:From; b=ocwxTn8GJNLpoNhfWWgnPPpvoNaU2KvPZSVB4xtrWW7LyxP7+Z6oQ5KMO3yBWfMn1 E3pIvX55Y1L0aA8wJLyTnZB8tRqG2G97nRTuX1adbyjE7ow4ioPI5dmqFWWLMrAyOC quZam66Bd5K/hprpZJpr4wx0kKooV/UwU8ZRLBPi9v/ohGcWCYxCQpKDe+XQ2rPEcN 0nvznUSLZII/kqiAokCIr8adAJjYx1blzvudS0+dd53NaIj+aPlT9QdGhDoG3z9Yjw HVHFaNCNILE74NsMGOoiPdG7o67IVjnUd87BcsmN+sCr6gYtfLitgrN8MMq19wlu1r /VGqxxKA8uGig== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4Nnf0Y0VMZz9rxB for ; Thu, 5 Jan 2023 08:55:38 +0100 (CET) Received-SPF: pass client-ip=185.67.36.65; envelope-from=yantar92@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 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, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:252563 Archived-At: Hi, There have been a discussion [1] about including some of the helpful package [2] features into built-in *Help* buffers. One of the discussed features was displaying function source code right in *Help* buffers. This feature usefulness have been objected at that time, on the grounds that showing function code may be too long and cause large *Help* buffers. Recently, we have stumbled upon a situation when showing function code is not only useful, but one of the few sane ways to examine it [3]. Functions that are not directly written in the source but rather generated programmatically cannot currently be easily examined using built-in help functionality (using describe-function or other means). The help buffer only links to the (point-min) in the library defining the generated function - not very helpful. In contrast, helpful extracts function body from symbol function slot. To illustrate, one can try the following: 1. emacs -Q 2. M-: (require 'ob-shell) 3. f org-babel-execute:sh 4. Click on the source code link in *Help* buffer 5. Observe point jumping to (point-min) with no obvious way to find the function definition. Would it be possible to provide function body info via *Help* system in Emacs? [1] https://yhetil.org/emacs-devel/AM9PR09MB4977A7738F83C5C24EF5829196D59@AM9PR09MB4977.eurprd09.prod.outlook.com [2] https://github.com/Wilfred/helpful [3] https://orgmode.org/list/87h6x8kluc.fsf@localhost In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.35, cairo version 1.17.6) of 2023-01-02 built on localhost Repository revision: 9377a3c889aa3b178a11a3b849c3d1665da096d6 Repository branch: master Windowing system distributor 'The X.Org Foundation', version 11.0.12101004 System Description: Gentoo Linux -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at