unofficial mirror of bug-guile@gnu.org 
 help / color / mirror / Atom feed
From: Neil Jerram <neil@ossau.uklinux.net>
To: Andy Wingo <wingo@pobox.com>
Cc: bug-guile@gnu.org, Noah Lavine <noah549@gmail.com>,
	Neil Jerram <neiljerram@googlemail.com>
Subject: Re: Lack of Documentation for (ice-9 regex) in Guile 1.9.10
Date: Sat, 30 Oct 2010 16:03:34 +0100	[thread overview]
Message-ID: <87bp6bpoyb.fsf@ossau.uklinux.net> (raw)
In-Reply-To: m339xlze6j.fsf@pobox.com

Andy Wingo <wingo@pobox.com> writes:

> On Thu 20 May 2010 03:36, Noah Lavine <noah549@gmail.com> 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



  parent reply	other threads:[~2010-10-30 15:03 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-05-19 20:58 Lack of Documentation for (ice-9 regex) in Guile 1.9.10 Noah Lavine
2010-05-20  1:36 ` Noah Lavine
2010-05-21 11:28   ` Andy Wingo
2010-05-21 13:48     ` Neil Jerram
2010-10-30 15:03     ` Neil Jerram [this message]
2010-10-31  0:46       ` Noah Lavine
2010-10-31  8:38         ` Neil Jerram

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/guile/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87bp6bpoyb.fsf@ossau.uklinux.net \
    --to=neil@ossau.uklinux.net \
    --cc=bug-guile@gnu.org \
    --cc=neiljerram@googlemail.com \
    --cc=noah549@gmail.com \
    --cc=wingo@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).