From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.bugs Subject: bug#36478: Perhaps rearrange *Help* buffer a bit? Date: Mon, 08 Jul 2019 19:30:21 -0400 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="7066"; 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: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Jul 09 01:47:37 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 1hkdM7-0001hP-T6 for geb-bug-gnu-emacs@m.gmane.org; Tue, 09 Jul 2019 01:47:36 +0200 Original-Received: from localhost ([::1]:45642 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hkd7a-0007aw-12 for geb-bug-gnu-emacs@m.gmane.org; Mon, 08 Jul 2019 19:32:34 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36965) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hkd6H-0007Eu-AL for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 19:31:14 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hkd6A-0000Zm-AX for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 19:31:09 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:51153) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hkd66-0000YI-Pz for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 19:31:04 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hkd66-0004dN-LQ for bug-gnu-emacs@gnu.org; Mon, 08 Jul 2019 19:31:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 08 Jul 2019 23:31: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.156262863215853 (code B ref 36478); Mon, 08 Jul 2019 23:31:02 +0000 Original-Received: (at 36478) by debbugs.gnu.org; 8 Jul 2019 23:30:32 +0000 Original-Received: from localhost ([127.0.0.1]:59973 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hkd5b-00047K-NI for submit@debbugs.gnu.org; Mon, 08 Jul 2019 19:30:32 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:10402) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hkd5a-00040T-8S for 36478@debbugs.gnu.org; Mon, 08 Jul 2019 19:30:30 -0400 Original-Received: from pmg1.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg1.iro.umontreal.ca (Proxmox) with ESMTP id A629F100737; Mon, 8 Jul 2019 19:30:24 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg1.iro.umontreal.ca (Proxmox) with ESMTP id 2C69810067D; Mon, 8 Jul 2019 19:30:23 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1562628623; bh=gnKbVu51wG2psFSSlHiGOIzR1M29tqii12zCXEoW98U=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=HeKHTbGqSjcGlPmMHrvgZbLMjhUu0j9wK5oX3NMR2rlEhg4TwYYo2cxY++uJ0jq8R Gm7WA5QoaH7lVEDyYX1RvfAc4tyPo97eBR5bAJdqssGHqJiqJ1r6qUFApvQKIg6YEc 2IGBOXQjeMcUm6n7C46Ula1hMtYNBkzAJp6e9PG+WCV94AUH13rPSzzDbB0KjU/81l g+871Epmi0NDV/rjVkL7x6Y1kH1einxvSfhM6dxrt+8thPWtKbKR6hgXAfcEx2QTuk kxG8oo1ipdfzCyJec/mlTKLrsAiC7mD1QusMtpNIEvNoPUxQ+sNuHUZxtTH+zj0hgu 6ezhQgHN8ZnUw== Original-Received: from alfajor (76-10-138-228.dsl.teksavvy.com [76.10.138.228]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 99FF1120152; Mon, 8 Jul 2019 19:30:22 -0400 (EDT) In-Reply-To: (Lars Ingebrigtsen's message of "Tue, 09 Jul 2019 00:26:29 +0200") 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:162405 Archived-At: > 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 rel= ated basic > Lisp concepts such as car, cdr, cons cell and list. > --- Sounds about right, yes. I think I'd vote to keep the function/macro distinction displayed by default at least (and maybe function/command as well). Maybe simply as Function: (car LIST) ... =20=20=20=20 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-saf= e=E2=80=99. =20=20=20=20 See Info node =E2=80=98(elisp)Cons Cells=E2=80=99 for a discussion of r= elated basic Lisp concepts such as car, cdr, cons cell and list. > 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. Sounds good. >> - 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? Maybe you're right. Then again, I think it's worth keeping the block highlighted somehow to clearly indicate the difference between the docstring and the auto-generated metadata, maybe with a discreet background color. Stefan