Re: manual examples - self contained or not?

2012-02-22 Thread Ludovic Courtès
Hi Ian, Ian Price ianpric...@googlemail.com skribis: Some manual examples, however, do include imports https://www.gnu.org/software/guile/manual/html_node/Hash-Table-Reference.html includes srfis 1 and 13. An example in https://www.gnu.org/software/guile/manual/html_node/Dynamic-FFI.html

Re: manual examples - self contained or not?

2012-02-21 Thread Neil Jerram
Nala Ginrut nalagin...@gmail.com writes: well, I don't believe in copy-paste code too. But my vote would be at least I can trust the official manual... I did think it would be nice, a while back, if we could implement a way of automatically checking that the examples in the manual are still

Re: manual examples - self contained or not?

2012-02-21 Thread Andy Wingo
On Tue 21 Feb 2012 22:14, Neil Jerram n...@ossau.homelinux.net writes: Does anyone fancy the automatic checking project? Someone could use our lovely (texinfo) modules :-) Andy -- http://wingolog.org/

manual examples - self contained or not?

2012-02-19 Thread Ian Price
Hi guilers, is there an official policy on whether or not examples in the manual should be self contained? On IRC, kudkudyak was confused about read-line not being found when he tried to run one of the socket examples. Naturally, I pointed out that this is because read-line is in (ice-9

Re: manual examples - self contained or not?

2012-02-19 Thread Nala Ginrut
well, I don't believe in copy-paste code too. But my vote would be at least I can trust the official manual... On Mon, Feb 20, 2012 at 12:42 AM, Ian Price ianpric...@googlemail.comwrote: Hi guilers, is there an official policy on whether or not examples in the manual should be self

Re: manual examples - self contained or not?

2012-02-19 Thread Noah Lavine
Hello, My vote would be for self-contained: it can be copied directly into a file or REPL and executed, and IMO reduces confusion. I already try to do this when posting any examples on paste.lisp.org or in a gist. When you say self-contained, do you mean that if the example uses a procedure

Re: manual examples - self contained or not?

2012-02-19 Thread Andy Wingo
On Sun 19 Feb 2012 17:42, Ian Price ianpric...@googlemail.com 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.