From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#36478: Perhaps rearrange *Help* buffer a bit? Date: Tue, 09 Jul 2019 00:26:29 +0200 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="225616"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: bug#36478 <36478@debbugs.gnu.org> To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Jul 09 00:27:12 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hkc6K-000wa1-Jq for geb-bug-gnu-emacs@m.gmane.org; Tue, 09 Jul 2019 00:27:12 +0200 Original-Received: from localhost ([::1]:45306 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hkc6J-0004iq-Ge for geb-bug-gnu-emacs@m.gmane.org; Mon, 08 Jul 2019 18:27:11 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49805) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hkc6D-0004g0-En for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 18:27:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hkc6C-0007HB-89 for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 18:27:05 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:51033) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hkc6A-0007Gi-Bw for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 18:27:04 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hkc6A-00069l-7J for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 18:27:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 08 Jul 2019 22:27:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 36478 X-GNU-PR-Package: emacs Original-Received: via spool by 36478-submit@debbugs.gnu.org id=B36478.156262479623634 (code B ref 36478); Mon, 08 Jul 2019 22:27:02 +0000 Original-Received: (at 36478) by debbugs.gnu.org; 8 Jul 2019 22:26:36 +0000 Original-Received: from localhost ([127.0.0.1]:59854 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hkc5k-000698-9T for submit@debbugs.gnu.org; Mon, 08 Jul 2019 18:26:36 -0400 Original-Received: from quimby.gnus.org ([80.91.231.51]:34690) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hkc5j-00068z-2A for 36478@debbugs.gnu.org; Mon, 08 Jul 2019 18:26:35 -0400 Original-Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=stories) by quimby.gnus.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hkc5d-0005mB-IV; Tue, 09 Jul 2019 00:26:32 +0200 Face: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwBAMAAAClLOS0AAAAFVBMVEXw4sqykINZDASXcGD+ /OtyPB/SuK5HtkdZAAACfElEQVQ4jXWTsXLbMAyG4ZrVLEaq5oY5d7ZKyTN5wXFOlCgzWat4/0fo D8pxlxZ3uVD8APwAAVO00Q+ZmmLtsvHBW5FshsNGJTYi0gH+chc7SiZq8sY9bSngerTZPLhHhBIV n/vQE3OaEZ+p/HQvBu6dtdvlakgkjlYaa+2De4G7hYiJAwMkEeu9zV/ci9jB5qb0FoBDEEgg+283 iNRcW4tUjUWJNpPgj4MJxQ+y9Wmj4Zwg3XTjxjBoSRbTh40u5yBNQV16z0W0174tSNVRgUTJFQQE db63mWm8RH0G2cxOUK81LVKZmGxGwb0CaA+SszlElJsIlVsxCiigDmjEC9N2DI0dpAEIcCMS9MET 01XLRRc30CCXGAUck+TSWVaQWJ+TDPcK4A4vVo3EotPZ4siUS7Kd9ziZQAf+tr6t63REHaWNfvZv r0EjIs+L9+sUkUq647rO62vIFSAYgIUptc8r7KPBLPmZZ2SdJylMlxArSLdU8zr4KW1M1h7/RkSa 9WNqk6HRV7A+BQUOJ2gMANxUsDzp2z47rXadus6QPVfx5VFBPNXoaTgYaveq1h+aKq07yNFgfMfF wfEDLwSNau9GNcKxfnzXt0s3ENC5PXz9BHwH6Vw7rx9nTRVQhYJnbGIZjjcAAlAjDhajpBpxanGi gICTW94FK5pu4hWQgtW952Aoph3kCua9j4JUh+ZaFes9/VwXBYK9Emy7mv4Q5B5xZfK+VDA737mx Hv2ETaZo4v5Aznu332OCWIZktNwTZMDWz0dkneDVnXDrXGW1wUm3SadzWrSu2sMeMfEOdlPvG8DG 6jLcwWfI1NaI6O827//6iyj4h0n+D4D9AehP82BHjrQVAAAAAElFTkSuQmCC In-Reply-To: (Stefan Monnier's message of "Mon, 08 Jul 2019 17:14:05 -0400") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:162388 Archived-At: Stefan Monnier writes: > Here's my favorite color:=20 > - don't move it to the end, because it's much too far. > - hide it by default, with some obvious-enough button-like thingy to > expand it on demand. > - maybe the first line could also be moved into this "metadata" block. A button that says "Technical details..." or something? Or... a text-less button would perhaps be better. To take the `car' example again: --- (car LIST) ... Return the car of LIST. If arg is nil, return nil. Error if arg is not nil and not a cons cell. See also =E2=80=98car-safe=E2= =80=99. See Info node =E2=80=98(elisp)Cons Cells=E2=80=99 for a discussion of relat= ed basic Lisp concepts such as car, cdr, cons cell and list. --- The "..." after the function call signature could be marked in the link face, and could expand into: --- car is a built-in function in =E2=80=98C source code=E2=80=99. Probably introduced at or before Emacs version 1.2. This function does not change global state, including the match data. --- And `car' in the signature could be a link to the source code, as the "C source code" is now, so you don't have to expand the details to get to the link. > - These *Help* buffers would benefit from a bit of face-lift (e.g. put > a different face on the metadata part, yet another on the > calling-convention example, ...). The parameters are in an italic face... If we're hiding the details, perhaps a special face for the details isn't necessary? --=20 (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no