From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Kelly Dean Newsgroups: gmane.emacs.devel Subject: [PATCH] Unify fn and var help to make learning elisp a little easier Date: Thu, 6 Dec 2012 10:59:36 -0800 (PST) Message-ID: <1354820376.62901.YahooMailClassic@web141102.mail.bf1.yahoo.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="-2140344373-363957233-1354820376=:62901" X-Trace: ger.gmane.org 1354831177 25341 80.91.229.3 (6 Dec 2012 21:59:37 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 6 Dec 2012 21:59:37 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Dec 06 22:59:50 2012 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 1TgjTx-00026s-Up for ged-emacs-devel@m.gmane.org; Thu, 06 Dec 2012 22:59:50 +0100 Original-Received: from localhost ([::1]:60915 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tgj5P-000787-MO for ged-emacs-devel@m.gmane.org; Thu, 06 Dec 2012 16:34:27 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:50139) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tggff-0004ya-FR for emacs-devel@gnu.org; Thu, 06 Dec 2012 13:59:51 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1TggfZ-0001hK-IH for emacs-devel@gnu.org; Thu, 06 Dec 2012 13:59:43 -0500 Original-Received: from nm7.bullet.mail.bf1.yahoo.com ([98.139.212.166]:24714) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TggfZ-0001h8-8j for emacs-devel@gnu.org; Thu, 06 Dec 2012 13:59:37 -0500 Original-Received: from [98.139.212.153] by nm7.bullet.mail.bf1.yahoo.com with NNFMP; 06 Dec 2012 18:59:36 -0000 Original-Received: from [98.139.212.233] by tm10.bullet.mail.bf1.yahoo.com with NNFMP; 06 Dec 2012 18:59:36 -0000 Original-Received: from [127.0.0.1] by omp1042.mail.bf1.yahoo.com with NNFMP; 06 Dec 2012 18:59:36 -0000 X-Yahoo-Newman-Property: ymail-3 X-Yahoo-Newman-Id: 662465.15683.bm@omp1042.mail.bf1.yahoo.com Original-Received: (qmail 1327 invoked by uid 60001); 6 Dec 2012 18:59:36 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yahoo.com; s=s1024; t=1354820376; bh=jNTe7J7rcxeNyoRCms1ai6UPlSOL3DMzKPMc5jU0kq0=; h=X-YMail-OSG:Received:X-Rocket-MIMEInfo:X-Mailer:Message-ID:Date:From:Subject:To:MIME-Version:Content-Type; b=eqW5ds73GCms+mVAzbCGmvKQdXomH9d6kH3TaZnzvCKKCzmgS1pIDZixbVLMzLQPlsH8DR7XSzlGGRNmBoDEBHCySGusCtWLY7St8EIwNyr4GVVFPYtR7Oge4mfSAjbongZ5lEwdYudrvnShsGkdwJxLOTI3Titosxdehcyyr2Y= DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=s1024; d=yahoo.com; h=X-YMail-OSG:Received:X-Rocket-MIMEInfo:X-Mailer:Message-ID:Date:From:Subject:To:MIME-Version:Content-Type; b=uEC3yyDt8QRvWA0gi4ufVZL4nExwLhIb0RDIt07MygCaRZ6z/RwRYRNqhf15XAskB8RqExCFsfmEhbC1pzTan0a/M1yJWq228kvequd07MnUaDToU/4ZyA+oue33KdjOKY9qoXLv+WXutU7ISkxmpktOmsKT+9H9gANegNEmWe0=; X-YMail-OSG: cVYZXkAVM1m1ptAluDAe_OubsZ0DYBiIdDxRfW_BfseAUgZ QJ54ShuRwVB9VkxH5ugUSbPDLrWaGC3cBKUlELdwSZCUZKRoCAcUAxwO56k9 .m45ww.egt3q0fg5EIiuG4TwyHR0BXMJl2qA5Og5eUc0yD0aiALHAYSUmClO 23fuMKegfD7mfmqRpsEL.RMlRAgv8deqDWHh8OyoZJhur2el4NFj5ZK8BNLz dRZ7CvQwyHHzBpXvPsrkA_F1XWdmy1JjDzqY4lGIjrl10qCZNm2sJ0r6HWA8 bdJme87V9v45oOnncGQKGug_J0vQqSjPVLA0v30pUm9HUia9Mn.BRbwrZe7B r8r7IKpb7.mDkd.Dt0xVRrYEqxxq9nKYGRBdDCdXzWb27GuPNoLh_SdX73Qp vDyLMiJWfD1bdFGkTDyL9ncnX_jUKVKgo39YUvaAGnZC3D7O1v1pN9NA- Original-Received: from [188.163.24.157] by web141102.mail.bf1.yahoo.com via HTTP; Thu, 06 Dec 2012 10:59:36 PST X-Rocket-MIMEInfo: 001.001, QSBuZXcgdXNlciB3aWxsIG9mdGVuIG5vdCByZW1lbWJlciB3aGV0aGVyIGEgc3ltYm9sIGhlIGhhcyBpbiBtaW5kIGlzIGEgZnVuY3Rpb24gb3IgdmFyaWFibGUsIHNvIGhlIGRvZXNuJ3Qga25vdyB3aGV0aGVyIHRvIHVzZSBDLWggZiBvciBDLWggdiB0byBnZXQgaGVscCBmb3IgaXQuIEZvciBleGFtcGxlIGRvIEkgdXNlIG1hcmsgb3IgKG1hcmspPyBDLWggdiBtYXJrIFRBQiBUQUIsIGl0J3Mgbm90IHRoZXJlLCBDLWcgQy1oIGYgbWFyayBUQUIgVEFCLCB0aGVyZSBpdCBpcy4gTGF0ZXIgSSdtIGxvb2tpbmcBMAEBAQE- X-Mailer: YahooMailClassic/15.1.1 YahooMailWebService/0.8.128.478 X-detected-operating-system: by eggs.gnu.org: FreeBSD 8.x X-Received-From: 98.139.212.166 X-Mailman-Approved-At: Thu, 06 Dec 2012 16:34:26 -0500 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 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-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:155325 Archived-At: ---2140344373-363957233-1354820376=:62901 Content-Type: text/plain; charset=us-ascii A new user will often not remember whether a symbol he has in mind is a function or variable, so he doesn't know whether to use C-h f or C-h v to get help for it. For example do I use mark or (mark)? C-h v mark TAB TAB, it's not there, C-g C-h f mark TAB TAB, there it is. Later I'm looking for mark-active and try C-h f first, and again have to cancel and switch. Also, when a symbol is used as both a function and a variable, a new user would want to know about this, but he's not going to find out by using C-h f or C-h v unless he manually tries both every time he looks up something new, which is inconvenient. A help command which provides completion on both functions and variables, and if a symbol is used as both, shows the help pages for both, solves both problems. The attached patch is a simple union of describe-function and describe-variable to do this. It triggers bug# 13105, but I sent a fix for that. BTW am I supposed to send little things like this to emacs-devel, or to bug-gnu-emacs, or just post on the wiki? It isn't a bug, but some of the docs say the bug list is also for new features and patches so they can be tracked by bug number, but they also say if a patch needs discussion then it should go to the devel list. Maybe it's superfluous, not worth cluttering Emacs with it. ---2140344373-363957233-1354820376=:62901 Content-Type: text/x-diff; name="descfunorvar.patch" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="descfunorvar.patch" LS0tIGVtYWNzLTI0LjIvbGlzcC9oZWxwLWZucy5lbAorKysgZW1hY3MtMjQu Mi9saXNwL2hlbHAtZm5zLmVsCkBAIC04OTcsNiArODk3LDM3IEBACiAKIAog Ozs7IyMjYXV0b2xvYWQKKyhkZWZ1biBkZXNjcmliZS1mdW5jdGlvbi1vci12 YXJpYWJsZSAoc3ltYm9sICZvcHRpb25hbCBidWZmZXIgZnJhbWUpCisgICJE aXNwbGF5IHRoZSBmdWxsIGRvY3VtZW50YXRpb24gb2YgdGhlIGZ1bmN0aW9u IG9yIHZhcmlhYmxlIFNZTUJPTC4KK0lmIFNZTUJPTCBpcyBhIHZhcmlhYmxl IGFuZCBoYXMgYSBidWZmZXItbG9jYWwgdmFsdWUgaW4gQlVGRkVSIG9yIEZS QU1FCitcKGRlZmF1bHQgdG8gdGhlIGN1cnJlbnQgYnVmZmVyIGFuZCBjdXJy ZW50IGZyYW1lKSwgaXQgaXMgZGlzcGxheWVkIGFsb25nCit3aXRoIHRoZSBn bG9iYWwgdmFsdWUuIgorICAoaW50ZXJhY3RpdmUKKyAgIChsZXQqICgodi1v ci1mICh2YXJpYWJsZS1hdC1wb2ludCkpCisJIChmb3VuZCAoc3ltYm9scCB2 LW9yLWYpKQorCSAodi1vci1mIChpZiBmb3VuZCB2LW9yLWYgKGZ1bmN0aW9u LWNhbGxlZC1hdC1wb2ludCkpKQorCSAoZm91bmQgKG9yIGZvdW5kIHYtb3It ZikpCisJIChlbmFibGUtcmVjdXJzaXZlLW1pbmlidWZmZXJzIHQpCisJIHZh bCkKKyAgICAgKHNldHEgdmFsIChjb21wbGV0aW5nLXJlYWQgKGlmIGZvdW5k CisJCQkJICAgIChmb3JtYXQKKwkJCQkgICAgICJEZXNjcmliZSBmdW5jdGlv biBvciB2YXJpYWJsZSAoZGVmYXVsdCAlcyk6ICIgdi1vci1mKQorCQkJCSAg IkRlc2NyaWJlIGZ1bmN0aW9uIG9yIHZhcmlhYmxlOiAiKQorCQkJCW9iYXJy YXkKKwkJCQkobGFtYmRhICh2dikKKwkJCQkgIChvciAoZmJvdW5kcCB2dikK KwkJCQkgICAgICAoZ2V0IHZ2ICd2YXJpYWJsZS1kb2N1bWVudGF0aW9uKQor CQkJCSAgICAgIChhbmQgKGJvdW5kcCB2dikgKG5vdCAoa2V5d29yZHAgdnYp KSkpKQorCQkJCXQgbmlsIG5pbAorCQkJCShpZiBmb3VuZCAoc3ltYm9sLW5h bWUgdi1vci1mKSkpKQorICAgICAobGlzdCAoaWYgKGVxdWFsIHZhbCAiIikK KwkgICAgICAgdi1vci1mIChpbnRlcm4gdmFsKSkpKSkKKyAgKGlmIChub3Qg KHN5bWJvbHAgc3ltYm9sKSkgKG1lc3NhZ2UgIllvdSBkaWRuJ3Qgc3BlY2lm eSBhIGZ1bmN0aW9uIG9yIHZhcmlhYmxlIikKKyAgICAodW5sZXNzIChidWZm ZXItbGl2ZS1wIGJ1ZmZlcikgKHNldHEgYnVmZmVyIChjdXJyZW50LWJ1ZmZl cikpKQorICAgICh1bmxlc3MgKGZyYW1lLWxpdmUtcCBmcmFtZSkgKHNldHEg ZnJhbWUgKHNlbGVjdGVkLWZyYW1lKSkpCisgICAgKGhlbHAteHJlZi1pbnRl cm5lZCBzeW1ib2wgYnVmZmVyIGZyYW1lKSkpCisKKzs7OyMjI2F1dG9sb2Fk CiAoZGVmdW4gZGVzY3JpYmUtc3ludGF4ICgmb3B0aW9uYWwgYnVmZmVyKQog ICAiRGVzY3JpYmUgdGhlIHN5bnRheCBzcGVjaWZpY2F0aW9ucyBpbiB0aGUg c3ludGF4IHRhYmxlIG9mIEJVRkZFUi4KIFRoZSBkZXNjcmlwdGlvbnMgYXJl IGluc2VydGVkIGluIGEgaGVscCBidWZmZXIsIHdoaWNoIGlzIHRoZW4gZGlz cGxheWVkLgotLS0gZW1hY3MtMjQuMi9saXNwL2hlbHAtbW9kZS5lbAorKysg ZW1hY3MtMjQuMi9saXNwL2hlbHAtbW9kZS5lbApAQCAtNjI3LDEwICs2Mjcs MTMgQEAKIAogDAogOzsgQWRkaXRpb25hbCBmdW5jdGlvbnMgZm9yIChyZS0p Y3JlYXRpbmcgdHlwZXMgb2YgaGVscCBidWZmZXJzLgotKGRlZnVuIGhlbHAt eHJlZi1pbnRlcm5lZCAoc3ltYm9sKQorCis7OzsjIyNhdXRvbG9hZAorKGRl ZnVuIGhlbHAteHJlZi1pbnRlcm5lZCAoc3ltYm9sICZvcHRpb25hbCBidWZm ZXIgZnJhbWUpCiAgICJGb2xsb3cgYSBoeXBlcmxpbmsgd2hpY2ggYXBwZWFy ZWQgdG8gYmUgYW4gYXJiaXRyYXJ5IGludGVybmVkIFNZTUJPTC4KIEJvdGgg dmFyaWFibGUsIGZ1bmN0aW9uIGFuZCBmYWNlIGRvY3VtZW50YXRpb24gYXJl IGV4dHJhY3RlZCBpbnRvIGEgc2luZ2xlCi1oZWxwIGJ1ZmZlci4iCitoZWxw IGJ1ZmZlci4gSWYgU1lNQk9MIGlzIGEgdmFyaWFibGUsIGluY2x1ZGUgYnVm ZmVyLWxvY2FsIHZhbHVlIGZvciBvcHRpb25hbAorQlVGRkVSIG9yIEZSQU1F LiIKICAgKHdpdGgtY3VycmVudC1idWZmZXIgKGhlbHAtYnVmZmVyKQogICAg IDs7IFB1c2ggdGhlIHByZXZpb3VzIGl0ZW0gb24gdGhlIHN0YWNrIGJlZm9y ZSBjbG9iYmVyaW5nIHRoZSBvdXRwdXQgYnVmZmVyLgogICAgIChoZWxwLXNl dHVwLXhyZWYgbmlsIG5pbCkKQEAgLTY0Niw3ICs2NDksNyBAQAogCQkJICAo Z2V0IHN5bWJvbCAndmFyaWFibGUtZG9jdW1lbnRhdGlvbikpCiAJCSAgOzsg RG9uJ3QgcmVjb3JkIHRoZSBjdXJyZW50IGVudHJ5IGluIHRoZSBzdGFjay4K IAkJICAoc2V0cSBoZWxwLXhyZWYtc3RhY2staXRlbSBuaWwpCi0JCSAgKGRl c2NyaWJlLXZhcmlhYmxlIHN5bWJvbCkpKSkKKwkJICAoZGVzY3JpYmUtdmFy aWFibGUgc3ltYm9sIGJ1ZmZlciBmcmFtZSkpKSkKICAgICAgIChjb25kCiAg ICAgICAgKHNkb2MKIAk7OyBXZSBub3cgaGF2ZSBhIGhlbHAgYnVmZmVyIG9u IHRoZSB2YXJpYWJsZS4KLS0tIGVtYWNzLTI0LjIvbGlzcC9oZWxwLmVsCisr KyBlbWFjcy0yNC4yL2xpc3AvaGVscC5lbApAQCAtOTAsNiArOTAsNyBAQAog ICAgIChkZWZpbmUta2V5IG1hcCAiayIgJ2Rlc2NyaWJlLWtleSkKICAgICAo ZGVmaW5lLWtleSBtYXAgImwiICd2aWV3LWxvc3NhZ2UpCiAgICAgKGRlZmlu ZS1rZXkgbWFwICJtIiAnZGVzY3JpYmUtbW9kZSkKKyAgICAoZGVmaW5lLWtl eSBtYXAgIm8iICdkZXNjcmliZS1mdW5jdGlvbi1vci12YXJpYWJsZSkKICAg ICAoZGVmaW5lLWtleSBtYXAgIm4iICd2aWV3LWVtYWNzLW5ld3MpCiAgICAg KGRlZmluZS1rZXkgbWFwICJwIiAnZmluZGVyLWJ5LWtleXdvcmQpCiAgICAg KGRlZmluZS1rZXkgbWFwICJQIiAnZGVzY3JpYmUtcGFja2FnZSkKQEAgLTIx NSw2ICsyMTYsNyBAQAogbSAgICAgICAgICAgRGlzcGxheSBkb2N1bWVudGF0 aW9uIG9mIGN1cnJlbnQgbWlub3IgbW9kZXMgYW5kIGN1cnJlbnQgbWFqb3Ig bW9kZSwKICAgICAgICAgICAgICAgaW5jbHVkaW5nIHRoZWlyIHNwZWNpYWwg Y29tbWFuZHMuCiBuICAgICAgICAgICBEaXNwbGF5IG5ld3Mgb2YgcmVjZW50 IEVtYWNzIGNoYW5nZXMuCitvIFNZTUJPTCAgICBEaXNwbGF5IHRoZSBnaXZl biBmdW5jdGlvbiBvciB2YXJpYWJsZSdzIGRvY3VtZW50YXRpb24gYW5kIHZh bHVlLgogcCBUT1BJQyAgICAgRmluZCBwYWNrYWdlcyBtYXRjaGluZyBhIGdp dmVuIHRvcGljIGtleXdvcmQuCiByICAgICAgICAgICBEaXNwbGF5IHRoZSBF bWFjcyBtYW51YWwgaW4gSW5mbyBtb2RlLgogcyAgICAgICAgICAgRGlzcGxh eSBjb250ZW50cyBvZiBjdXJyZW50IHN5bnRheCB0YWJsZSwgcGx1cyBleHBs YW5hdGlvbnMuCg== ---2140344373-363957233-1354820376=:62901--