From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Philippe Vaucher Newsgroups: gmane.emacs.devel Subject: Prefixed manual describe-function and api overview Date: Thu, 4 Jun 2020 11:39:22 +0200 Message-ID: Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="120060"; mail-complaints-to="usenet@ciao.gmane.io" To: Emacs developers , =?UTF-8?B?Sm/Do28gVMOhdm9yYQ==?= , Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Jun 04 11:40:25 2020 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 1jgmML-000V8A-2N for ged-emacs-devel@m.gmane-mx.org; Thu, 04 Jun 2020 11:40:25 +0200 Original-Received: from localhost ([::1]:46320 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jgmMK-0002eu-4s for ged-emacs-devel@m.gmane-mx.org; Thu, 04 Jun 2020 05:40:24 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:57138) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jgmLn-00022Y-96 for emacs-devel@gnu.org; Thu, 04 Jun 2020 05:39:51 -0400 Original-Received: from mail-lj1-x22c.google.com ([2a00:1450:4864:20::22c]:46818) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jgmLm-0003kE-Ff; Thu, 04 Jun 2020 05:39:50 -0400 Original-Received: by mail-lj1-x22c.google.com with SMTP id z9so6396730ljh.13; Thu, 04 Jun 2020 02:39:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to; bh=dO0MnFnpJe0HMVpi6mNZ9X+akMCrji7+cffXy2yOWgc=; b=AQJgE6vgA8+ouh0iy2qHRy91DDDRHlQ+exqnMsmpLDwRmbemtFMPwvkX+6HmnsJT3S gRjZ3Tv7PLkD8tMISnnny/IdFYY9Nz1kCH+B5hrab3O5cIY7rKB907eh+G+cIJ8kSZ94 FDKGNXq84fyx4WOzbYJELUasLABGbTrMnILxT4OOEOjwZljfuT6Y2JOEZ+wnGBbuXyYC LqgB8m/OEX/th5HZ5MajTsf1Wv3pmb16PjdujyPtZ22zDXhxpypWyA+XQm6LL2kiM1PQ 9PBv4ZCZW71KF5TsscB3c/DpDCnif+irSfM9URyWbBWmBRGr694Vb59GBH2/L8kolQDd UZIg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=dO0MnFnpJe0HMVpi6mNZ9X+akMCrji7+cffXy2yOWgc=; b=RK17MNJAxp0uFU8/u1elwJRFc359J/s3NkCPXWhc7kea+yuZHWpImMryvTYH7j+eGG lYWS67gwesDdPt7tnuoYmB3Vt55jJ4gANb5e6BtGfxp4GkDhcATvgkQjHGf33fNBqc4j uH8GIhmSshWf67A6N7RmyWeliIZJOpDUF4wvrv9RXCwIhJmIBvZmeygn5pJvqBd8Wejb tTd9C0EG8bT5pfzRvS/j+Zyy4/aSXz+BbDAqNetGaXsmth4a+gP6AxivpDSySIlU3Jn1 eK8EqJu702j4326nXYgbmLQ3/c0i/3plj9fGCzdOMvNmUaBRJyPnhyBE4sNTL8DOMw9N ZCRw== X-Gm-Message-State: AOAM532HjoW+/ZJ1hFTboSnXAU2KyN2DmCMfjZo/e07TIo0FaVboGxj2 XBZqPvRhfzeGz8T0Mvsr/B63lvISRfL36A4hX0bsbAUHeGc= X-Google-Smtp-Source: ABdhPJy+pXiZpFT9PuyjS0tsl+SZwRRgNZmKoEgQ0hfL1SUFgrL0WosHgDLx1thG7/xOveACgDy37r6OSo9xKcaP4cQ= X-Received: by 2002:a05:651c:318:: with SMTP id a24mr81319ljp.55.1591263587294; Thu, 04 Jun 2020 02:39:47 -0700 (PDT) Received-SPF: pass client-ip=2a00:1450:4864:20::22c; envelope-from=philippe.vaucher@gmail.com; helo=mail-lj1-x22c.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. 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_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=_AUTOLEARN 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:251848 Archived-At: Hello, Following up on our previous discussions, here is a working implementation of the completion mechanism based on the manual: https://github.com/Silex/prefixed-manual.el/blob/master/prefixed-manual.el At the moment it uses https://melpa.org/#/dash and https://melpa.org/#/s so make sure you have these dependencies. Then to try it out, test with `M-x prefixed-manual-describe-function` and `M-x prefixed-manual-overview`. The later still needs a lot of work but it gives an idea. Here are my questions/plans: - If there is interest for some parts for the core, I'll rewrite this in vanilla Emacs. - I'm not sure I like "prefixed-manual", given this is more about "manual-helpers". Feel free to suggest a better name. - In `prefixed-manual-overview`, I'd like to display the full signature of functions. For example display "(substring-no-properties STRING &optional FROM TO)" instead of "substring-no-properties". If you know a simple way I'm interested. I tried to use something like `(get 'substring-no-properties 'function-documentation)` or play with `documentation-property` but couldn't find easily and gave up. Kind regards, Philippe