From: ludo@gnu.org (Ludovic Courtès)
To: guile-devel@gnu.org
Subject: Re: Documenting (system repl server)
Date: Wed, 27 Mar 2013 22:10:33 +0100 [thread overview]
Message-ID: <871ub0r1km.fsf@gnu.org> (raw)
In-Reply-To: 87hak8r0qm.fsf@Kagami.home
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’.
next prev parent reply other threads:[~2013-03-27 21:10 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-03-18 19:01 Documenting (system repl server) Ian Price
2013-03-27 21:10 ` Ludovic Courtès [this message]
2013-03-27 21:35 ` Andy Wingo
2013-03-28 0:32 ` Ian Price
2013-03-28 0:24 ` Ian Price
2013-03-28 16:51 ` Ludovic Courtès
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=871ub0r1km.fsf@gnu.org \
--to=ludo@gnu.org \
--cc=guile-devel@gnu.org \
/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).