From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Ted Zlatanov Newsgroups: gmane.emacs.devel Subject: Re: tags for functions Date: Fri, 30 Jan 2009 09:34:50 -0600 Organization: =?utf-8?B?0KLQtdC+0LTQvtGAINCX0LvQsNGC0LDQvdC+0LI=?= @ Cienfuegos Message-ID: <864ozgajtx.fsf@lifelogs.com> References: <867i4pemv5.fsf@lifelogs.com> <86y6x49un4.fsf@lifelogs.com> <86ljt39ysz.fsf@lifelogs.com> <87tz7oxodr.fsf@jurta.org> <86mydd3kzv.fsf@lifelogs.com> <87pri9k64b.fsf@jurta.org> <86ljsw252p.fsf@lifelogs.com> <87hc3kfgb8.fsf@jurta.org> <86r62ne3aq.fsf@lifelogs.com> <86bptrdv4f.fsf@lifelogs.com> <861vuldgmu.fsf@lifelogs.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: ger.gmane.org 1233329718 4722 80.91.229.12 (30 Jan 2009 15:35:18 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 30 Jan 2009 15:35:18 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Jan 30 16:36:32 2009 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1LSvOW-0007No-Vw for ged-emacs-devel@m.gmane.org; Fri, 30 Jan 2009 16:35:01 +0100 Original-Received: from localhost ([127.0.0.1]:42630 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1LSvNE-0004Ms-TD for ged-emacs-devel@m.gmane.org; Fri, 30 Jan 2009 10:33:40 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1LSvN9-0004MT-H2 for emacs-devel@gnu.org; Fri, 30 Jan 2009 10:33:35 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1LSvN9-0004MB-1S for emacs-devel@gnu.org; Fri, 30 Jan 2009 10:33:35 -0500 Original-Received: from [199.232.76.173] (port=41879 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1LSvN8-0004M6-Sa for emacs-devel@gnu.org; Fri, 30 Jan 2009 10:33:34 -0500 Original-Received: from main.gmane.org ([80.91.229.2]:37231 helo=ciao.gmane.org) by monty-python.gnu.org with esmtps (TLS-1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1LSvN8-00031K-AB for emacs-devel@gnu.org; Fri, 30 Jan 2009 10:33:34 -0500 Original-Received: from list by ciao.gmane.org with local (Exim 4.43) id 1LSvN0-0000tx-6q for emacs-devel@gnu.org; Fri, 30 Jan 2009 15:33:26 +0000 Original-Received: from 38.98.147.130 ([38.98.147.130]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 30 Jan 2009 15:33:26 +0000 Original-Received: from tzz by 38.98.147.130 with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Fri, 30 Jan 2009 15:33:26 +0000 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 50 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: 38.98.147.130 X-Face: bd.DQ~'29fIs`T_%O%C\g%6jW)yi[zuz6; d4V0`@y-~$#3P_Ng{@m+e4o<4P'#(_GJQ%TT= D}[Ep*b!\e,fBZ'j_+#"Ps?s2!4H2-Y"sx" User-Agent: Gnus/5.110011 (No Gnus v0.11) Emacs/23.0.60 (gnu/linux) Cancel-Lock: sha1:GmIrLIzyIq5xENVHsf+UuPvRcV8= X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6, seldom 2.4 (older, 4) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:108409 Archived-At: On Thu, 29 Jan 2009 16:52:04 -0500 Stefan Monnier wrote: >> Then Emacs will use it, for example, to show related functions in C-h f >> The package can also provide browsing by keyword, as finder.el does. SM> I see, thanks. The list of related functions can be rather long, so SM> it's probably better to only add a "show related" button in C-h f and SM> only show the list when the user asks for it. OK. >> 2) scan existing docstrings over mapatoms using `documentation' (it's >> slow now apparently, so it will need to be optimized for a batch scan) SM> If it's only done "once per session" and only when the user specifically SM> asks for this info, it's probably not that bad. OK. >> I only need defun-after-hook to be approved, I can do the rest. Do you >> agree it's useful or would you rather not provide such a hook? SM> I'm not convinced. I'm not even sure this kind of info will turn out to SM> be useful/usable. Currently, you'd spend all your time scanning SM> docstrings that don't contain any such keywords. We have to start somewhere. It's definitely useful to me, and two other people that started the original thread. The example that brought it up is that motion functions are legion in the Emacs Lisp namespace, and have wildly disparate names. A "motion" tag would allow a curious explorer to see what other motion commands exist from any starting point. I suggested some other tags. SM> Adding those keywords to docstrings would be a major undertaking. SM> So it's probably better to start with data from elsewhere (e.g. from SM> the elisp manual) anyway. Yes, but I'm sure it can be automated a bit regardless. The hard part, actually, is picking the right keywords as others have pointed out. SM> In other words, maybe a defun-after-hook ill be the right tool, but SM> we're pretty far from being in a position to judge, and it seems likely SM> that the end design will use a completely different approach anyway. Understood. Rather than overengineer, I will provide a simple working solution that uses docstring tags, gathering them all when it's first loaded as a package (so autoloading will DTRT as you suggested). If it needs optimizations, they can be added later. Ted