Re: Docstrings

[Keisuke Nishida]

At 08 Apr 2001 22:52:53 -0400,
Ariel Rios wrote:
> 
> I do not know much about docstrings but I want to do the following:
> (help socket) displays the information rather than returning a string.
> I want to be able to do so because I have built a function called
> (repl-help func) that intends to show the info about that function
> as html inside  GtkHTML, Is this possible w/out having to modify help
> from session.scm?

(help socket) already displays the information.
Do you want a string instead?  If so, `object-documentation'
in (ice-9 documentation) is for you:

guile> (use-modules (ice-9 documentation))
guile> (object-documentation socket)
$1 = " - primitive: socket family style proto
     Return a new socket port of the type specified by FAMILY, STYLE
     and PROTOCOL.  All three parameters are integers.  Typical values
     for FAMILY are the values of `AF_UNIX' and `AF_INET'.  Typical
     values for STYLE are the values of `SOCK_STREAM', `SOCK_DGRAM' and
     `SOCK_RAW'.  PROTOCOL can be obtained from a protocol name using
     `getprotobyname'.  A value of zero specifies the default protocol,
     which is usually right.  A single socket port cannot by used for
     communication until it has been connected to another socket."

(BTW, (with-output-to-string (lambda () (help socket))) doesn't work. Why?)

Keisuke