From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.devel Subject: Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED] Date: Sun, 18 Oct 2020 08:50:55 -0700 Message-ID: References: <20201015190929.gdvx7j2yukcdcoaw@E15-2016.optimum.net> <83pn5jwav0.fsf@gnu.org> <20201015194132.jdn3e2v62vfvh7ju@E15-2016.optimum.net> <83imbawu6y.fsf@gnu.org> <20201016073432.4bmahi4jna2xxayl@E15-2016.optimum.net> <20201018144345.wgrbsivvzuuohbj5@E15-2016.optimum.net> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="36778"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Eli Zaretskii , emacs-devel@gnu.org To: Boruch Baum , Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Oct 18 17:51:36 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 1kUAy8-0009T4-I6 for ged-emacs-devel@m.gmane-mx.org; Sun, 18 Oct 2020 17:51:36 +0200 Original-Received: from localhost ([::1]:45684 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kUAy7-0004e0-GY for ged-emacs-devel@m.gmane-mx.org; Sun, 18 Oct 2020 11:51:35 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50874) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kUAxZ-00048b-Hh for emacs-devel@gnu.org; Sun, 18 Oct 2020 11:51:01 -0400 Original-Received: from mail-ej1-x631.google.com ([2a00:1450:4864:20::631]:47026) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kUAxX-0003FX-Pn; Sun, 18 Oct 2020 11:51:01 -0400 Original-Received: by mail-ej1-x631.google.com with SMTP id t25so10385812ejd.13; Sun, 18 Oct 2020 08:50:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:in-reply-to:references:mime-version:date:message-id:subject:to :cc; bh=uoNz5U2PbYAXSl00d528MjA4MUbU0NDSIao91mN0NPo=; b=Tr9Y4nyzilN8bMlAlP7TxRvAGlLwg421sJSKBeDpUL2MeQ9R8yIw39LjlGLXoOCiDs dc6R/e52w1Hp6o30aHdK/iG4O+SEPI63FFUtUSJkQhPtQdQNSdID0VJng3LfpWRrr34+ t2zJFpvcUcVdWxiDyJucAEn56+5gp4Cm/QBdGgwvmYXZgcwhrW7tZhOOUnj7bF0BUbd6 W8+/LeiTwLKjaSh+IuuiiLuXcGnkZkQPJ8LV9r37fwgKNp6rHVU15c/aJjF8d8a/yTAo 80IM5YkyiRiBigsIEtz7HHeO0Pc/MRXaUi5CWdMWoXfJM04qOakt13IhaQPg8+zeCQaR uBGQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:in-reply-to:references:mime-version:date :message-id:subject:to:cc; bh=uoNz5U2PbYAXSl00d528MjA4MUbU0NDSIao91mN0NPo=; b=cS/Zbo3WgHFj7O4maCQ9kwgZMXeL4+0PhjiHOvqU0eo7Radxbl/FsErvvAxXrLrzLF fd4BM9vqNuCd233S/g6i+34aTXm2vM6twUlTW/Tnnb0RC97u6NSfciFpeAyY2UryfUsE mxytpr00lo7d8P94iaprlYVbODhxt4fm1Z4iQCiquYFTQ00iDhLw0x8y0OSvqAAm7xph NA9/yWR5YyD8iEU311pWSYZJLCN4gKHElsniMKrDa9h0NEK55G3U+Cu/mWb3ym5A9wTO DKQ2O1ZUasGHalfxMglRKwa2uyKybGAR7U+DKJs2S6Sew93nYytELCQNW3huaUblqB/j u2pA== X-Gm-Message-State: AOAM530H0X7uu7u127+3rdzrL2HaMPNv3crqANlC/MwvC9xUvDEEcBhR byAxnpWor9xufOuCExNG/g5t+TMCJ8kQ8B1V2Nc= X-Google-Smtp-Source: ABdhPJz9vwQAWs2n10QMZ1x8umUh4Wwj+dq5xtDE44z8H+L/ySCCIabnnKItdAqkyuCUkZ6u0LBoSPVSib+EIpfSHNI= X-Received: by 2002:a17:906:1957:: with SMTP id b23mr12922943eje.312.1603036256892; Sun, 18 Oct 2020 08:50:56 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sun, 18 Oct 2020 08:50:55 -0700 In-Reply-To: <20201018144345.wgrbsivvzuuohbj5@E15-2016.optimum.net> Received-SPF: pass client-ip=2a00:1450:4864:20::631; envelope-from=stefankangas@gmail.com; helo=mail-ej1-x631.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_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:258038 Archived-At: Boruch Baum writes: >> IOW what would be the advantage of adding a link in `C-h P` to your >> system, instead of just replacing `C-h P` with your system? > > IMO: Just losing the heading summary, but that code can be integrated so > that nothing would be lost. Having tested your code, I agree that we should keep `C-h P' as-is, but extend it with everything from the "** Code:" header and down in your code. (I guess that part could be collapsed by default in order to not overwhelm a user with details?) It would be great if one could also collapse the "Commentary" section. I would also give it a headline "Description:" using the same font as "Status:". We would also need to check that this works also for packages that are not installed (they don't need to show the full documentation, I don't think, but they should at least not be broken ;-). Bonus points if we can also add a link to the relevant Info manual, where there is one. BTW, does this all really need to be based on Org-mode? Perhaps one could make it look more polished by rolling a custom solution here, and I'm not exactly sure what using Org-mode buys us in this case. Three more nits: - I wouldn't show obsolete aliases. - The autoload cookies should probably get a better representation than just being copied in. - The doc strings should be passed to `substitute-command-keys' before display.