From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Noah Lavine Newsgroups: gmane.lisp.guile.bugs Subject: Re: Lack of Documentation for (ice-9 regex) in Guile 1.9.10 Date: Sat, 30 Oct 2010 20:46:14 -0400 Message-ID: References: <87bp6bpoyb.fsf@ossau.uklinux.net> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable X-Trace: dough.gmane.org 1288485991 15995 80.91.229.12 (31 Oct 2010 00:46:31 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Sun, 31 Oct 2010 00:46:31 +0000 (UTC) Cc: bug-guile@gnu.org To: Neil Jerram Original-X-From: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Sun Oct 31 02:46:26 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 1PCM40-0008GE-Ut for guile-bugs@m.gmane.org; Sun, 31 Oct 2010 02:46:25 +0200 Original-Received: from localhost ([127.0.0.1]:55154 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PCM40-0006uX-Du for guile-bugs@m.gmane.org; Sat, 30 Oct 2010 20:46:24 -0400 Original-Received: from [140.186.70.92] (port=58283 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PCM3u-0006rp-5z for bug-guile@gnu.org; Sat, 30 Oct 2010 20:46:19 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1PCM3s-0003SQ-Up for bug-guile@gnu.org; Sat, 30 Oct 2010 20:46:18 -0400 Original-Received: from mail-wy0-f169.google.com ([74.125.82.169]:48106) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1PCM3s-0003SK-Lr for bug-guile@gnu.org; Sat, 30 Oct 2010 20:46:16 -0400 Original-Received: by wyf23 with SMTP id 23so4665748wyf.0 for ; Sat, 30 Oct 2010 17:46:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:received:received:in-reply-to :references:date:message-id:subject:from:to:cc:content-type :content-transfer-encoding; bh=PF65Y/q4PC0Tz4H7aGFbhF0de3HNCMgu1IUi+eXS/pQ=; b=iPBp1W/aIC51D+qBnUVkOCPKQQH/j7NIw+4y0ZtzoNn2N5g7y5RTUc6M11kNeSJrsF mzVy95RabcJg7ijiFMVwH3wYD3ACxRAl57PtXkMgjrhfz+3CccNI+xQ5puVnc4SYELFN hfS0olemi83KJaQszmbkjm32rlWJMZl/2XX/8= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type:content-transfer-encoding; b=HQjSQ91uu5LZEWIj0m0IQUZhxNv/dwzFyhPu01PWmzoCZk31XA5ES0Dtd19lEqQK/R Tz+ct+tZiWjm+HZgwTY1lAQd1vt3tmOokRroqWAVzd9JKbBqFlp0jRiO2TDSntXWSA9H zT4UuzngLkQEdCL7S897GfSLdCAmZgZRvwE4k= Original-Received: by 10.216.157.132 with SMTP id o4mr1048952wek.7.1288485974532; Sat, 30 Oct 2010 17:46:14 -0700 (PDT) Original-Received: by 10.216.237.34 with HTTP; Sat, 30 Oct 2010 17:46:14 -0700 (PDT) In-Reply-To: <87bp6bpoyb.fsf@ossau.uklinux.net> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) 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:4845 Archived-At: Hello, The issue I had with finding documentation for regexes was that I didn't think to guess where the documentation was in the manual, and I didn't know about the info help commands. On the one hand, I realize it's a small problem, because now that I know where it is, it's easy for me to use the documentation. On the other hand, I think it's an issue that other people might have, and therefore it would be worth fixing. If you look at the "Simple Data Types" section of the manual, regular expressions are very different than the other things in the menu: numbers, characters, strings, bytevectors, etc. The manual section they are most similar to is the one on LALR(1) Parsing. I would put the regular expressions bit in the main menu for the API, just above LALR(1) Parsing, to make it easier to find. Noah On Sat, Oct 30, 2010 at 11:03 AM, Neil Jerram wrot= e: > 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. =A0As 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. =A0Or, we could do something more general: basically > post-process the manual in some way so that it can provide online help > strings. =A0Any 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.) > > =A0 =A0 =A0Neil >