From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Neil Jerram Newsgroups: gmane.lisp.guile.bugs Subject: Re: Lack of Documentation for (ice-9 regex) in Guile 1.9.10 Date: Sat, 30 Oct 2010 16:03:34 +0100 Message-ID: <87bp6bpoyb.fsf@ossau.uklinux.net> References: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: dough.gmane.org 1288459910 22329 80.91.229.12 (30 Oct 2010 17:31:50 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Sat, 30 Oct 2010 17:31:50 +0000 (UTC) Cc: bug-guile@gnu.org, Noah Lavine , Neil Jerram To: Andy Wingo Original-X-From: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Sat Oct 30 19:31:44 2010 Return-path: Envelope-to: guile-bugs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1PCFHJ-00063K-Jy for guile-bugs@m.gmane.org; Sat, 30 Oct 2010 19:31:41 +0200 Original-Received: from localhost ([127.0.0.1]:59361 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PCFHJ-0000Ok-13 for guile-bugs@m.gmane.org; Sat, 30 Oct 2010 13:31:41 -0400 Original-Received: from [140.186.70.92] (port=51635 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PCFHB-0000Oc-Op for bug-guile@gnu.org; Sat, 30 Oct 2010 13:31:36 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1PCFHA-0000Km-QQ for bug-guile@gnu.org; Sat, 30 Oct 2010 13:31:33 -0400 Original-Received: from mail3.uklinux.net ([80.84.72.33]:59932) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1PCFHA-0000Jc-M3 for bug-guile@gnu.org; Sat, 30 Oct 2010 13:31:32 -0400 Original-Received: from arudy (unknown [78.149.124.242]) by mail3.uklinux.net (Postfix) with ESMTP id 89BA71F6735; Sat, 30 Oct 2010 18:31:30 +0100 (BST) Original-Received: from neil-laptop (unknown [192.168.1.5]) by arudy (Postfix) with ESMTP id 512AE38013; Sat, 30 Oct 2010 18:32:01 +0100 (BST) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.1 (gnu/linux) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4-2.6 X-BeenThere: bug-guile@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GUILE, GNU's Ubiquitous Extension Language" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Errors-To: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.bugs:4840 Archived-At: Andy Wingo writes: > On Thu 20 May 2010 03:36, Noah Lavine writes: > >> I found the documentation in info - sorry for the confusion. It didn't >> occur to me that a regexp would be considered a "Simple Data Type". > > Interesting observation. Copying Neil, who's working on the manual :) Old email alert... As far as the manual is concerned, I don't see anything else that we could do. As things stand, the index entries for `regex' and `string-match' go straight to the relevant doc, and if you do `i match', the third result is the doc for match objects. The online help - currently nothing at all - could be improved, though. We could address this particular case by cutting/pasting/editing from the manual text. Or, we could do something more general: basically post-process the manual in some way so that it can provide online help strings. Any thoughts on that? (To get this to work, we might need a commenting convention to indicate which module the following section of manual is covering.) Neil