From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Arthur Miller Newsgroups: gmane.emacs.devel Subject: Re: Helpful in Emacs? Date: Thu, 09 Sep 2021 17:48:08 +0200 Message-ID: References: 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="14509"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: me@wilfred.me.uk, Stefan Kangas , Emacs developers To: Daniel =?utf-8?Q?Mart=C3=ADn?= Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Sep 09 17:49:27 2021 Return-path: Envelope-to: ged-emacs-devel@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 1mOMIn-0003Vj-O3 for ged-emacs-devel@m.gmane-mx.org; Thu, 09 Sep 2021 17:49:27 +0200 Original-Received: from localhost ([::1]:54920 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mOMIm-0002bH-6c for ged-emacs-devel@m.gmane-mx.org; Thu, 09 Sep 2021 11:49:24 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:48828) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mOMHk-0001Pk-K1 for emacs-devel@gnu.org; Thu, 09 Sep 2021 11:48:21 -0400 Original-Received: from mail-oln040092065040.outbound.protection.outlook.com ([40.92.65.40]:43266 helo=EUR01-HE1-obe.outbound.protection.outlook.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mOMHd-0008T0-B7 for emacs-devel@gnu.org; Thu, 09 Sep 2021 11:48:16 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=R5E8hLl79lMauwdG64pL5+hPhtjlNxOC1cxSbbBET/v8ArrLxbwJqRYD/pK9Gt0Q7prIqsZ4QLnejI/XILmChnO9oTvBrgEvU14vN2dz4/xFM/3ncEypwsiY/bgzoFMuLLc83T/xINaEJpXEn9uIDB6VIXEh3gBCXzAWshVowwqxlevvU9Py9V/qx9hECu9zQ0UpWYrt21xiPNHoY7RAzDqmDAjFShbx8RaBc1KsDnwkWYQrIBNVcnpr0zdLE3v6AW6OCuVx4qqSewa+3BpXN5P+6wnour6nPmZ6U1+FiaX81OkwwhJPZdQAjoXmprcEQCoB6aSmKluoOYI1/SO7cQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=aOBoHza3WRoNi91BLN+iGhghpN71lJIKQ5W6Sw2E3+A=; b=nBq0H7I1kuMyK9NbNld79xJDft6LPC2giL4amgGsbaUG4iFvWOnO6XscqAS5NiutQK2v8K//4pTwjAi3jM0xHzLIVrPWNChYyBTN5f9WwRxuhlEwItPO88WqL9ZW61Em/r1JAjznNmcnFgjDWeDCnbxW4Wv/CM92OkaCzAEYuRBQmOYpefrH1fGgRg6IRkzTCtDQ1Y1VHaXNFRRG049HO+Bmwum9w4f3kXHP3g7q4RXlIWG9groKt4/JWzImTBIcN+VuVy1ZVJ/hD+vrJ+T3tXRp/gBQ9RhnvadGKCoAS0qbAT2SDIz9rW/uTSiolY2SU3n1s/tHL/Xywn7+SEftwQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=none; dmarc=none; dkim=none; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=live.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=aOBoHza3WRoNi91BLN+iGhghpN71lJIKQ5W6Sw2E3+A=; b=SEvNzkle+viQIZeYZSgtecHEfLf1fths+ekQw19nNInRC0wuIG3vP1EdOYFxCTN6boLQIZJyS8EoYXPOROPvWzgEvbMnZYHU5y2hRKjogywscMwfailbU/5VGkbFjV9mkV6OuMOVeLaItDVK5tsctH4jw94aLXbqmyfcLcuC+5yBGoF353iFet17z5DS1Yp09VqdoGuIFaaevCh9A5aaA3E+eGoy/d4FAPz4CJPdQYCCZVQnpsQOWbScDVpsd31BO+10YzBRtw3WoSWLMXk3EyABWNDhhRj50/dwF8uKMS0MtcypNzgaQBMx7q4P0ZUsBmGcN2YINJchLw7iG3PqQw== Original-Received: from AM9PR09MB4977.eurprd09.prod.outlook.com (2603:10a6:20b:304::20) by AM9PR09MB5188.eurprd09.prod.outlook.com (2603:10a6:20b:2ff::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4500.15; Thu, 9 Sep 2021 15:48:09 +0000 Original-Received: from AM9PR09MB4977.eurprd09.prod.outlook.com ([fe80::c55c:ece5:bed2:a9dc]) by AM9PR09MB4977.eurprd09.prod.outlook.com ([fe80::c55c:ece5:bed2:a9dc%8]) with mapi id 15.20.4500.016; Thu, 9 Sep 2021 15:48:09 +0000 In-Reply-To: ("Daniel =?utf-8?Q?Mart=C3=ADn=22's?= message of "Thu, 09 Sep 2021 17:21:30 +0200") X-TMN: [yocE9BdKKrq0z28DcJADhLTCxbq0z0VA] X-ClientProxiedBy: AM6PR02CA0002.eurprd02.prod.outlook.com (2603:10a6:20b:6e::15) To AM9PR09MB4977.eurprd09.prod.outlook.com (2603:10a6:20b:304::20) X-Microsoft-Original-Message-ID: <87r1dxwy13.fsf@live.com> X-MS-Exchange-MessageSentRepresentingType: 1 Original-Received: from pascal.homepc (81.232.177.30) by AM6PR02CA0002.eurprd02.prod.outlook.com (2603:10a6:20b:6e::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4500.14 via Frontend Transport; Thu, 9 Sep 2021 15:48:08 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: c1ba45bd-d076-4239-58c0-08d973a938b4 X-MS-TrafficTypeDiagnostic: AM9PR09MB5188: X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: rnZoa47L/IBOKbAus5p72EUqRiX49pNApHEbQ9ImjrzmwE/U/d38GNKvHIcO7ThLlEUHdZCUQSeMGiI6G0Ivi9Okm5NktFVbrHTKm0Y0g40NyCISdHfCT2YW8wOA2OsiTA0cJXBGYjxGR5aNfrakBs+uhuDXQxXCqlc8egueE8q9aYVS9cth3JL8T0tpCg4GCZ0PWM/8pm9UGy3rv8N9CufsEs0n8N8Cwbln0jvI5uILKtUExDzqfBbRbs1Eg55dQyiPZ8OP+fSycVXWSbTvF9oK21HFBM8k31u5FF2DYGj3vIa42LXM7MoOhzLasH1scGtsM9dbhppHH9g1vU+5tzQjD/ANMMavOO4qFPQ2kThcu3dJAoMV2G0vRQ0e3yP9ZJzK4wCx1JJxMAL1Q7AXopu0S8sGfCHbJmizk4wIwAgtiWQ6PuZeE9FCvETtrgnDgATS4X0BUTphf7Ajix7gjw4CGcY4tmFShz/uG3XWmMs= X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: S+p4JZ4sKNW2ZOR5eGEn8eRoZ8av0QXQhnmluuhpKTzSVTW6wSMZN/9pcV9HvvDDil7qsidVMlkpXelbdimxR+61r4ZGpqmMevUijAgn10ATsiN/NO5cY0VYEHGQK/TBXt+CS3ES//AuR4chTyOeUg== X-OriginatorOrg: sct-15-20-3174-20-msonline-outlook-72e6e.templateTenant X-MS-Exchange-CrossTenant-Network-Message-Id: c1ba45bd-d076-4239-58c0-08d973a938b4 X-MS-Exchange-CrossTenant-AuthSource: AM9PR09MB4977.eurprd09.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Sep 2021 15:48:09.1101 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM9PR09MB5188 Received-SPF: pass client-ip=40.92.65.40; envelope-from=arthur.miller@live.com; helo=EUR01-HE1-obe.outbound.protection.outlook.com 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, FREEMAIL_FROM=0.001, MSGID_FROM_MTA_HEADER=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:274457 Archived-At: Daniel Mart=C3=ADn writes: > Arthur Miller writes: > >> A week or two ago I was actually looking at Emacs help code. I wanted to= bring >> in the source code as well as references into help lookup, but honestly,= I would >> rather prefer to just include helpful instead of re-implementing everyth= ing. If >> the authors have signed the paperwork, I see no reason why not just incl= ude >> it. Also original help lookup could be left as low-resource, faster solu= tion for >> people who prefer to spend less resources on help lookup, while helpful = could be >> enabled by a custom variable, something like show extended help or as >> a minor mode. > > Instead of integrating the library as a whole, I'd prefer we extract > those features from Helpful that people think are useful and not already > available in Emacs. I don't think that having two separate help systems > in core is a good idea, there'll be too much duplication and maintenance > burden. I don't think there is much of duplication there. Those two libraries don't share exactly same code, so extracting features is not as straightforward a= s one might expect. At least it seem so to me. In principle, extracting stuff fro= m helpful, would be as easy as to re-implement helpful for Emacs in that case. Maybe I am wrong, I am not very familiar with code bases for neither = of those, I just glanced over it a couple of weeks ago. But in general, I thin= k there are more fun places to hack on, than to reimplement somethign that al= ready works. Just bring it in :). Anyway for extracting something from helpful, there is still need for original author(s) to do the fsf paperwork, and to be willing to donate their code to Emacs. > Showing references to a symbol is an interesting feature (for example, > to learn how to use an ELisp API by looking at examples). I see that When things don't go the way I expect them, I use helpful to look up the function and see the source code. > Helpful provides this feature via the separate package elisp-refs > (https://github.com/Wilfred/elisp-refs). The closest package I know > that actually understands ELisp is el-search from ELPA, but elisp-refs > is a more specific package for the concrete use case of searching for > references. I have't looked how it does, but I guess you are correct.