From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Boruch Baum Newsgroups: gmane.emacs.devel Subject: Re: ~Make emacs friendlier: package documentation [POC CODE INCLUDED] Date: Sun, 18 Oct 2020 10:43:45 -0400 Message-ID: <20201018144345.wgrbsivvzuuohbj5@E15-2016.optimum.net> 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> 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="4942"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: NeoMutt/20180716 Cc: Eli Zaretskii , emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Oct 18 16:47:22 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 1kU9xx-00019H-OS for ged-emacs-devel@m.gmane-mx.org; Sun, 18 Oct 2020 16:47:21 +0200 Original-Received: from localhost ([::1]:32802 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kU9xw-0001Mn-8U for ged-emacs-devel@m.gmane-mx.org; Sun, 18 Oct 2020 10:47:20 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:41366) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kU9ue-0000hJ-OM for emacs-devel@gnu.org; Sun, 18 Oct 2020 10:43:56 -0400 Original-Received: from mout.gmx.net ([212.227.17.21]:34705) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kU9uc-0003mC-9m; Sun, 18 Oct 2020 10:43:56 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1603032229; bh=emUbVsn9w1TZhx+vSkIANsThAyvB5ACd9ucqBotS5M8=; h=X-UI-Sender-Class:Date:From:To:Cc:Subject:References:In-Reply-To; b=NaK3zbRlcmG0N7IDqTkyqu3ufvhINmZO6P5TnIFTE+QOmLKVmKtduM9CczU2Ags1A oGKtwCp7RO0HinBEvvvoqKVS3zpniswZk1cvQ4jGyoBOz2X1BHuwpx9de1Sl2RSF57 Adtrt2fQKxkhM5OaycM88GM6kVc0hUhYsp3Q2veg= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Original-Received: from E15-2016.optimum.net ([72.89.170.172]) by mail.gmx.com (mrgmx105 [212.227.17.174]) with ESMTPSA (Nemesis) id 1MMofc-1kkaKe2vQa-00IkTU; Sun, 18 Oct 2020 16:43:49 +0200 Content-Disposition: inline In-Reply-To: X-Provags-ID: V03:K1:5EZ5506h43a6Gt2wumt0j2ia71hIifg+LMOQvG0TsFITYTfs2er ivQTP/2MiKzyoaJnbz9Y2ye2APUeElHokG6ET+dinTgX+QYBtS6grX7+uNo1bAEuniWkFhn yvc1xtsuL/rrA3MIyDcevB0tvSyCDAZArvhId2Iaaw9iq+9r9TnoDQ7ZDo2zN+U5TtZKkSs IkPfx/sth4HDxX848dQMw== X-UI-Out-Filterresults: notjunk:1;V03:K0:w5/L9PFN2Lk=:teeveN+fL6xwsWhlGraTVv YWiWY0U0dIPuzxzh3pOro9JikSYrc8fhEsBmHmgiAtmNxC/XIWyBUE8lhjjJ8W1TPsEsbS+L5 7rElFHrPdEz/6Hc2MpJ2iHjbNaf2pQIhEmV8Y9StgbpXDaZJwzD+5deq7J3/jzOdJEYuW7GXB siCMtF8tq/jkFUzZQPmu7ZQ62SUso99sXkw1lUJQwD5ZDe3RxuOGS05Sj8MYIb1T6uWDlUEVz rCgJ5+Q46ags2yAHCLFlGChU3rlcROpetZQmJ97PzAwHhKwl/lpP1bfEFXcDKJawEUjgq2oUf 5JZ0I8BrpiQmWQkX6SK550sbqa9Bt5mlUyaGbH+qobQ5l03Tj1IIBS0FDwerwwVJ7kZuMc+kP CDygVNTZ3DNAdidrFJAd1IdgqEw0F9GC5mmlhFiOpAD8j3oIGiquYjW4aYgqB848jTtPr1LGe scEK15jLNqDxvjXRBGMnPbYMqwPHxSXRVqykliHN/MGegoOHWNbTB4jR9tH3BTYtCLoHwhoHh 5snRJ2i4O0y03cGSfKqUX23lVHOnSkRWG6dw7KKJ7Ki2q3sfAvLVYoqO18KeiSVYHw+QgCW+8 IxB8tTjBR4sogrLzUm+p0NazcBafDQcaIU5UWPUdeaeL48GiwgvLyS4oO8bW4YD7yqPEGlmqf EMCcxQLOJ0dPOCl12ZJdHNkN2J6MBLl1lMK93F9l21jNHHlZzASdyseMSSriGvglTyd8q7uZz vWWXdhBZxeIX9TG/ZUG9E0RPyIViuQdqR+dEgbz0yTQ6IkS2NUrzLYoOaesOk2uNHPN3eiwG Received-SPF: pass client-ip=212.227.17.21; envelope-from=boruch_baum@gmx.com; helo=mout.gmx.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/18 10:43:52 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, 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:258026 Archived-At: On 2020-10-18 09:11, Stefan Monnier wrote: > > 1) I share the sentiment about consolidating the help/describe command= s, > > and have no objection to the feature being accessed via a link in > > describe-package (ie. no direct dedicated keybinding). > > IIUC your pack-doc provides a superset of what `C-h P` provides. No, the only intersection is the 'commentary' text taken from the elisp file. describe-package presents a unique heading summary; for example: #+BEGIN_QUOTE yasnippet is a dependency package. Status: Installed in =E2=80=98yasnippet-20200524.2215/=E2=80=99 (un= signed). Version: 20200524.2215 Commit: d3d6d70b1cd4818d271752468e0fdb0788db750d Summary: Yet another snippet extension for Emacs Requires: cl-lib-0.5 Homepage: http://github.com/joaotavora/yasnippet Keywords: [convenience] [emulation] Other versions: 20200604.246 (melpa), 0.14.0 (gnu), 0.6.1 (marmalade). #+END_QUOTE > So what would be the downside(s) of replacing `C-h P` with your packdoc? I have no objection, but I do like the heading summary that describe-package presents, and think it would be a shame to lose it. > 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. Playing devil's advocate: I'm not any kind of UX psychologist, but if there is someone like that on the list, they could speak to the notion of it maybe being a situation of presenting 'too much information' for a user expecting the prior behavior or for a user just wanting the most basic package description or for a user unfamiliar with org-mode. =2D- hkp://keys.gnupg.net CA45 09B5 5351 7C11 A9D1 7286 0036 9E45 1595 8BC0