From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eduardo Ochs Newsgroups: gmane.emacs.devel Subject: Re: Helpful in Emacs? Date: Thu, 9 Sep 2021 16:21:33 -0300 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="37453"; mail-complaints-to="usenet@ciao.gmane.io" Cc: me@wilfred.me.uk, Stefan Kangas , Arthur Miller , Emacs developers To: =?UTF-8?Q?Daniel_Mart=C3=ADn?= Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Sep 09 21:23:09 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 1mOPdd-0009WV-6h for ged-emacs-devel@m.gmane-mx.org; Thu, 09 Sep 2021 21:23:09 +0200 Original-Received: from localhost ([::1]:58336 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mOPdc-0000RY-41 for ged-emacs-devel@m.gmane-mx.org; Thu, 09 Sep 2021 15:23:08 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35162) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mOPcL-00088y-Gh for emacs-devel@gnu.org; Thu, 09 Sep 2021 15:21:49 -0400 Original-Received: from mail-pg1-x52e.google.com ([2607:f8b0:4864:20::52e]:36586) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mOPcJ-0005Yk-8z for emacs-devel@gnu.org; Thu, 09 Sep 2021 15:21:49 -0400 Original-Received: by mail-pg1-x52e.google.com with SMTP id t1so2836000pgv.3 for ; Thu, 09 Sep 2021 12:21:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc:content-transfer-encoding; bh=BFXItp8/055byYMThfbI8+68P1BzHQDYke0LzDU0JOA=; b=jGa0KTbqKHdLhEB4O0v7R5ipOL+NSWeZFcvXJfu1+/TL+4fxyucPa/iMs+yjMGsulF NJ+A6PxCoIbeeInG969SVHaHOAM2LV3IjWb7y0XIZs+4DLYfWrzHNtH5BWyzlimo6Fx2 Pl9GvJ/OHybMrfz0YOfddD5v94W1BVyENKGAroBJhRAroBURuxaP7BZXOE0P4Eyd2DOD WWbH/8HgvmfGZmFIed+OsDE0iiA0PdOdTR6K/Z+VX+wHa6kVJ2rMcpcdjLzjJFQKpcah Z6fmro3IIo6x1tRTES9e08AyiWpYhnSHPA/p7aUOngdvzLSu0r/GUj2/yYdIhVHz7qNF bu8Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc:content-transfer-encoding; bh=BFXItp8/055byYMThfbI8+68P1BzHQDYke0LzDU0JOA=; b=Gd9qzYjnrnnBebEV2KP+4Nd0MgiaHP7FfY8p3pkWiyPfL7zSEX9MMrUAbWCs7Ra3gu d5TfVpeUicCDVDKBxjWu1Vi2Vzbdcqu4SfGGBx9puywQXjTh1JiwLzxn7N8jIIjnTxHB RSoWvM52nY6JpxtOLiugD3Fv8sdv5dpj3i6b2h/a3j8Wdh9bzUCNd3Q00D5RaTZVDxXg 0bjmS6mIrYD8WzRk0f3lnJk0vNRP2YVygPPT8ACnbcYwK/0AwbqhDtBul0HysGq4OkWU DxIi7JCFQuvhvZD8B/0XP11weajo8DbhzQ21GEmSog69oETmMyCwi+HzsSE1z4v8hjtX 8WVQ== X-Gm-Message-State: AOAM532BgqPClyVvoT1Y/qKfhbfvI3GyEky4rYcfFrD/B76t5YxqplhV orMs/lZe0b4csIR3GewjDkjkeHSx1/Hs2vNpMi0= X-Google-Smtp-Source: ABdhPJy4BTW/kvCbo3i7VoahG4w6NQwCBnhXuSvwMsOWGQ+juT1S7CBWw/J71pnKW2Q/WTejcGWgO6JXfcDz09qVdJU= X-Received: by 2002:a63:2343:: with SMTP id u3mr4088971pgm.100.1631215304774; Thu, 09 Sep 2021 12:21:44 -0700 (PDT) In-Reply-To: Received-SPF: pass client-ip=2607:f8b0:4864:20::52e; envelope-from=eduardoochs@gmail.com; helo=mail-pg1-x52e.google.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, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=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:274468 Archived-At: On Thu, 9 Sept 2021 at 12:22, Daniel Mart=C3=ADn wrote= : > > Arthur Miller writes: > > > A week or two ago I was actually looking at Emacs help code. I wanted t= o 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 everyt= hing. If > > the authors have signed the paperwork, I see no reason why not just inc= lude > > it. Also original help lookup could be left as low-resource, faster sol= ution 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. > > 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 > 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. > > If we can get copyright papers, perhaps we could start by integrating > the functionality of elisp-refs as an xref backend. Then the help > system could use the new backend to provide a "References" link button. Another vote for "extracting features"/"refactoring helpful" here... I tried to add support for helpful to eev about a year ago and I got lost and stuck - I only had a few hours to play with it, and I was not super focused, but was quite frustrated at the end. I was hoping that helpful would be structured as a library plus a front-end, and it was not. I'll try again this weekend. =3D/ Cheers, Eduardo Ochs http://angg.twu.net/#eev