From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.devel Subject: Re: display-completion-list should not strip text properties Date: Tue, 04 Sep 2007 12:54:39 +0300 Organization: JURTA Message-ID: <87abs2wyao.fsf@jurta.org> References: <877in93z6c.fsf@jurta.org> <87wsv71esh.fsf@jurta.org> <20070904084911.GA10705@www.trapp.net> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1188900051 7533 80.91.229.12 (4 Sep 2007 10:00:51 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Tue, 4 Sep 2007 10:00:51 +0000 (UTC) Cc: rms@gnu.org, drew.adams@oracle.com, emacs-devel@gnu.org To: tomas@tuxteam.de Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Sep 04 12:00:49 2007 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 1ISVD7-0004yH-DS for ged-emacs-devel@m.gmane.org; Tue, 04 Sep 2007 12:00:41 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1ISVD5-0005ky-IR for ged-emacs-devel@m.gmane.org; Tue, 04 Sep 2007 06:00:39 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1ISVCL-00054G-KG for emacs-devel@gnu.org; Tue, 04 Sep 2007 05:59:53 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1ISVCJ-0004zr-4R for emacs-devel@gnu.org; Tue, 04 Sep 2007 05:59:53 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1ISVCI-0004zW-Q3 for emacs-devel@gnu.org; Tue, 04 Sep 2007 05:59:50 -0400 Original-Received: from relay01.kiev.sovam.com ([62.64.120.200]) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1ISVCB-0008QJ-Tk; Tue, 04 Sep 2007 05:59:44 -0400 Original-Received: from [83.170.232.243] (helo=smtp.svitonline.com) by relay01.kiev.sovam.com with esmtp (Exim 4.67) (envelope-from ) id 1ISVC1-000O07-M8; Tue, 04 Sep 2007 12:59:42 +0300 In-Reply-To: <20070904084911.GA10705@www.trapp.net> (tomas@tuxteam.de's message of "Tue\, 4 Sep 2007 08\:49\:11 +0000") User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/23.0.50 (gnu/linux) X-Scanner-Signature: 308c5668300cb665e09cc4617523e4c8 X-DrWeb-checked: yes X-SpamTest-Envelope-From: juri@jurta.org X-SpamTest-Group-ID: 00000000 X-SpamTest-Header: Not Detected X-SpamTest-Info: Profiles 1428 [September 3 2007] X-SpamTest-Info: helo_type=3 X-SpamTest-Info: {HEADERS: header Content-Type found without required header Content-Transfer-Encoding} X-SpamTest-Method: none X-SpamTest-Rate: 10 X-SpamTest-Status: Not detected X-SpamTest-Status-Extended: not_detected X-SpamTest-Version: SMTP-Filter Version 3.0.0 [0255], KAS30/Release X-Detected-Kernel: FreeBSD 4.8-5.1 (or MacOS X 10.2-10.3) 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:77734 Archived-At: >> I think a better approach is to use a markup language in doc strings, >> be it XHTML or even TexinfoML. Then using a style sheet it can be >> formatted nicely in the Help buffer. Example of a doc string: > > My gut reaction is "Oh, no. Not Yet Another *ML". It's not very > constructive, but gut reactions ain't fair or constructive -- sorry for > that :-( > > (maybe those angle brackets just hurt my tummy too much ;) Don't be afraid of using markup languages. Such languages provide a good common denominator that allows creating packages that will process doc strings in different ways, e.g. writing a package producing a printed reference manual from doc strings (especially useful for packages that don't have a separate Info manual). Using Lisp expressions inside the doc strings has other drawbacks: writing expressions inside strings is poorly supported. Just think that really every quote should be escaped with \: "mumble \\,(propertize \"toto\" 'face 'highlight) titi" Compare this with: "mumble toto titi" You can argue that this can be written as: "mumble \\,(docstring-emph \"toto\") titi" but it has too many toothpicks. -- Juri Linkov http://www.jurta.org/emacs/