Re: Documenting (system repl server)

[ludo@gnu.org (Ludovic Courtès)]

Ian Price <ianprice90@googlemail.com> skribis:

> For now, I have currently placed it in a new subsection of 6.17 (Reading
> and Evaluating Scheme Code). I'm not entirely convinced this is the
> right place for it, better suggestions welcome.

Sounds good to me.

> For 2, I have described the optional in the text, rather than trying to
> placing the expression directly in the prototype.

This has been discussed recently, but I think what you wrote it OK.

> +@node REPL Servers
> +@subsection REPL Servers
> +
> +The procedures in this section are provided by
> +@lisp
> +(use-modules (system repl server))
> +@end lisp
> +
> +When an application is written in Guile, it is often convenient to
> +allow the user to be able to interact with it by evaluating Scheme
> +expressions in a REPL.

I would add something like “The procedures of this module allow you to
spawn a @dfn{REPL server}, which permits interaction over a local or TCP
connection.”

Also, what about mentioning --listen, with a xref, as an example use?

> +@deffn {Scheme Procedure} make-tcp-server-socket [#:host=#f] @
> +                          [#:addr] [#:port=37146]
> +Returns a stream socket bound to a given address @var{addr} and port

Should be “Return”.

> +@deffn {Scheme Procedure} make-unix-domain-server-socket [#:path="/tmp/guile-socket"]
> +Returns a UNIX domain socket, bound to a given @var{path}.

Ditto.

> +@deffn {Scheme Procedure} run-server [server-socket]
> +@deffnx {Scheme Procedure} spawn-server [server-socket]
> +@code{run-server} creates and runs a repl, making it available over

Rather “Create and run a REPL” (“REPL” always uppercase).

Also, two spaces after an end-of-sentence period (info "(texinfo) Not
Ending a Sentence").  :-)

Thanks for working on this!

Ludo’.