From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: Better help support for EIEIO classes and methods Date: Mon, 04 Feb 2013 14:53:53 -0500 Message-ID: References: <877gmpz9mt.fsf@engster.org> <87txprhq5g.fsf@engster.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1360007643 31292 80.91.229.3 (4 Feb 2013 19:54:03 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 4 Feb 2013 19:54:03 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Feb 04 20:54:21 2013 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 1U2S7Q-0005dM-Ee for ged-emacs-devel@m.gmane.org; Mon, 04 Feb 2013 20:54:20 +0100 Original-Received: from localhost ([::1]:37492 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1U2S77-0000ro-St for ged-emacs-devel@m.gmane.org; Mon, 04 Feb 2013 14:54:01 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:46098) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1U2S75-0000rh-GZ for emacs-devel@gnu.org; Mon, 04 Feb 2013 14:54:00 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1U2S74-00032n-Dq for emacs-devel@gnu.org; Mon, 04 Feb 2013 14:53:59 -0500 Original-Received: from ironport2-out.teksavvy.com ([206.248.154.182]:13482) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1U2S74-000329-AU for emacs-devel@gnu.org; Mon, 04 Feb 2013 14:53:58 -0500 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: Av4EABK/CFFFpZnt/2dsb2JhbABEvw4Xc4IeAQEEAVYoCws0EhQYDYhCBsEtjWGDKQOIYZwZgV6DFQ X-IPAS-Result: Av4EABK/CFFFpZnt/2dsb2JhbABEvw4Xc4IeAQEEAVYoCws0EhQYDYhCBsEtjWGDKQOIYZwZgV6DFQ X-IronPort-AV: E=Sophos;i="4.84,565,1355115600"; d="scan'208";a="426717" Original-Received: from 69-165-153-237.dsl.teksavvy.com (HELO pastel.home) ([69.165.153.237]) by ironport2-out.teksavvy.com with ESMTP/TLS/ADH-AES256-SHA; 04 Feb 2013 14:53:54 -0500 Original-Received: by pastel.home (Postfix, from userid 20848) id 74B3F590D7; Mon, 4 Feb 2013 14:53:53 -0500 (EST) In-Reply-To: <87txprhq5g.fsf@engster.org> (David Engster's message of "Mon, 04 Feb 2013 19:47:55 +0100") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux) X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 206.248.154.182 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:156823 Archived-At: >> To a large extent the first line is not that important since you can add >> the missing info in the docstring itself. Could you give more details of >> the things that can't be overcome this way? > An example: Start up with emacs -Q and eval > (require 'semantic/db) > (require 'semantic/db-global) > Then do a describe-function on semanticdb-file-table. You'll get this: > ,---- > | semanticdb-file-table is a Lisp function in `db.el'. > | > | (semanticdb-file-table &rest LOCAL-ARGS) > | > | From OBJ, return FILENAME's associated table object. > `---- > Now, this is pretty misleading since there are actually two > implementations of this function, which will become clear if you use > eieio-describe-generic, which will give you this: Here's a suggestion: in describe-function-1 we do: (help-fns--compiler-macro function) (help-fns--parent-mode function) (help-fns--obsolete function) How 'bout we replace that with (run-hook-with-args 'help-fns-describe-function-functions function) So EIEIO can add some text between "(semanticdb-file-table &rest LOCAL-ARGS)" and "From OBJ, return FILENAME's associated table object."? > This is already pretty good, but is still lacking an IMO crucial > feature: the filenames 'db.el' and 'db-global.el' are not > links. However, just do > (add-hook 'temp-buffer-show-hook 'eieio-help-mode-augmentation-maybee t) Can't you insert the `db.el' and `db-globals.el' directly as buttons? Or does something later strip away the text-properties of those buttons? If that's the case, maybe we could fix that problem. Stefan