guile-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: manual examples - self contained or not?


From: Andy Wingo
Subject: Re: manual examples - self contained or not?
Date: Sun, 19 Feb 2012 22:18:00 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/23.3 (gnu/linux)

On Sun 19 Feb 2012 17:42, Ian Price <address@hidden> writes:

> With the obvious exception of examples whose entire purpose is to show
> off the module system, and similar, I think we should adopt a consistent
> policy one way or the other, and adapt all the examples to it.

FWIW, I agree.

> My vote would be for self-contained: it can be copied directly into a
> file or REPL and executed, and IMO reduces confusion.

I agree also, with the caveat that a

  (use-modules (foo))

at the top of a manual page should imply that the module is used in all
subsequent examples.

Thoughts welcome from others, of course; and regardless, patches will
move the conversation along :)

Andy
-- 
http://wingolog.org/



reply via email to

[Prev in Thread] Current Thread [Next in Thread]