From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: John Wiegley Newsgroups: gmane.emacs.devel Subject: Re: Improving describe-mode and discoverability Date: Wed, 06 Jul 2016 10:47:08 -0700 Message-ID: References: <576C2A6C.3090908@gmail.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1467827325 13271 80.91.229.3 (6 Jul 2016 17:48:45 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 6 Jul 2016 17:48:45 +0000 (UTC) Cc: Emacs developers To: =?utf-8?Q?Cl=C3=A9ment?= Pit--Claudel Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Jul 06 19:48:37 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1bKqw7-00025I-9F for ged-emacs-devel@m.gmane.org; Wed, 06 Jul 2016 19:48:35 +0200 Original-Received: from localhost ([::1]:35103 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bKqw6-0005Wa-KW for ged-emacs-devel@m.gmane.org; Wed, 06 Jul 2016 13:48:34 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51784) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bKqvG-0005W2-Qu for emacs-devel@gnu.org; Wed, 06 Jul 2016 13:47:43 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bKqvD-0004ST-EY for emacs-devel@gnu.org; Wed, 06 Jul 2016 13:47:41 -0400 Original-Received: from mail-pa0-x236.google.com ([2607:f8b0:400e:c03::236]:35655) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bKqvD-0004SE-7z for emacs-devel@gnu.org; Wed, 06 Jul 2016 13:47:39 -0400 Original-Received: by mail-pa0-x236.google.com with SMTP id dx3so13629603pab.2 for ; Wed, 06 Jul 2016 10:47:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:in-reply-to:date:message-id:references :user-agent:mail-followup-to:mime-version:content-transfer-encoding; bh=yty7MVLa3DzkqmnuFsVE9u0iNjj+5OlTzeyZHZ40VTI=; b=o5GhLr6Ol84N9Ov+Yo9xo5A8/SsWtgPIhsmgk2JrkBk0Wz+j2wJJLqRnBY2EmH0UXK Dq9B7UIGHP1DmrxtY2xTzzDEO8xLbGsb4eq0yPWqPOWWaBHQHgyEhoSgR7UmVLHHFZuZ Du60ZjhGSMpZyWMaAUAvylwracDTn3YY2TdSL1aCbXozJ8NXJ7GWVK+k4DbJFSjbk4hN U/dsv0hEb02pFP1Mwg8t2bcu8855ZCh05hiSObnztAS3IjfqaygOS9U2Svxi9pfUrQ4G rPZTHUI/VWlbqoAd2JeVcS0vtNCGyKh/z1v3VP4j68xx7qQaDTHYi/kdb6azuVJIImgY Wl0Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:in-reply-to:date:message-id :references:user-agent:mail-followup-to:mime-version :content-transfer-encoding; bh=yty7MVLa3DzkqmnuFsVE9u0iNjj+5OlTzeyZHZ40VTI=; b=kzYr4qobZbySuACoqn0NRsXhF7pW9DpfpafzEenBDFGxfptICc8JswQMAL/wwwtd9p 5s2WoqsiiVfbjDWAXSdizY+zIFo2WmrIrLVHMssSVljGUbFbvFVVlS9bsLFI/6uxBXcf 7LnA0B4HycfyL0G0ILr5peVgKxKKcR2nc4dbTLcBwsSIpUKbqJAhafkg2Vu0vwCeZpoP z7wHdrdEReyPsNbJD1w1Kz+uwKODOdNoQQwwh8Hf5mefVCvMAoPgAF4AGrTWQ3LQYaiF 8nmcgA2Az3BW/xEGHCGUxek9yO9fZgKL2xPMQwuTYTGcC8RklbF6IC63Kj4EAUy1ehOn HswA== X-Gm-Message-State: ALyK8tJbX+j/pB7YL5LPSAVwo4f24J+ukwCmzApb3G/lvJhqAUasOrHza8BIQ9JwBHcUuA== X-Received: by 10.66.193.39 with SMTP id hl7mr24231547pac.10.1467827258342; Wed, 06 Jul 2016 10:47:38 -0700 (PDT) Original-Received: from Vulcan.local (76-234-68-79.lightspeed.frokca.sbcglobal.net. [76.234.68.79]) by smtp.gmail.com with ESMTPSA id 77sm5718929pfp.66.2016.07.06.10.47.36 (version=TLS1 cipher=AES128-SHA bits=128/128); Wed, 06 Jul 2016 10:47:37 -0700 (PDT) X-Google-Original-From: "John Wiegley" Original-Received: by Vulcan.local (Postfix, from userid 501) id F0185FB582B; Wed, 6 Jul 2016 10:47:35 -0700 (PDT) In-Reply-To: <576C2A6C.3090908@gmail.com> (=?utf-8?Q?=22Cl=C3=A9ment?= Pit--Claudel"'s message of "Thu, 23 Jun 2016 14:29:00 -0400") User-Agent: Gnus/5.130014 (Ma Gnus v0.14) Emacs/25.0.95 (darwin) Mail-Followup-To: =?utf-8?Q?Cl=C3=A9ment?= Pit--Claudel , Emacs developers X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2607:f8b0:400e:c03::236 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 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.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:205277 Archived-At: >>>>> Cl=C3=A9ment Pit--Claudel writes: > What do you think? I would be happy to get help in refining this code (and > this proposal). For example, we could consider hyperlinking the function > names to their sources, or letting users expand the first line of the > documentation to show the full docstring. We could also think about ways = to > cover functions that are not bound to a key by default, but which users m= ay > want to bind (e.g. by looking for interactive functions starting with the > mode's name). This is wonderful, Cl=C3=A9ment! However, I wouldn't change the behavior of `describe-mode': I'd add a new function (in ELPA to begin with) called `describe-mode-verbose', and then advise `describe-mode' so that, at the beginning or end of the help buffer, a button appears leading one to that information. --=20 John Wiegley GPG fingerprint =3D 4710 CF98 AF9B 327B B80F http://newartisans.com 60E1 46C4 BD1A 7AC1 4BA2