unofficial mirror of bug-guile@gnu.org 
 help / color / mirror / Atom feed
* [DOCPATCH]Revamp of doc/ref/scheme-control.texi
@ 2003-07-16 17:37 Stephen Compall
  2003-07-17 22:50 ` Kevin Ryde
  2003-07-23 23:53 ` Kevin Ryde
  0 siblings, 2 replies; 7+ messages in thread
From: Stephen Compall @ 2003-07-16 17:37 UTC (permalink / raw)


Well, the first half (or so) of it anyway.

I was planning on saving this until I could get all the way through
the file, but it's getting a little unwieldy, so please have a look.
ChangeLog at the bottom of this email.

A great deal of the diff is due to moving the named let description to
the *beginning* of node `while do'.  I felt this appropriate, as named
let seems to be a more important and powerful construct than either
while or do.

COPYRIGHT!  I have a request for assignment of past and future changes
pending.

Also, as far as I can see, an old patch on srfi-modules.texi from May
(http://mail.gnu.org/archive/html/bug-guile/2003-05/msg00000.html)
hasn't been acted upon, as I haven't seen it applied nor rejected by
email.  It conflicts now, so please let me know if you (being whoever
applies patches nowadays) would like me to regenerate it from my
(conflict resolved) version.  I have some new updates for
srfi-modules.texi since then anyway.

2003-07-16  Stephen Compall  <s11@member.fsf.org>

	* scheme-control.texi (Dynamic Wind): Explain concept of dynamic
	context more fully.

	Cleaned up example text: reindented, appropriate @print and
	@result, @r for comments.

	Changed _ in variables to -.

	(Multiple Values): Removed redundant wording.

	(begin): Converted Yet Another passive text to active.

	(Exception Terminology): Reworked the guide to list all the terms
	in table form, along with their collective definitions.

2003-07-15  Stephen Compall  <s11@member.fsf.org>

	* scheme-control.texi (while do): Continue converting to active
	voice.

	(Continuations): Tried to explain them, and created full, useful,
	working example.

2003-06-09  Stephen Compall  <s11@member.fsf.org>

	* scheme-control.texi (if cond case): Summarized `cond' in one
	sentence.

	(and or): Eliminated redundant index entries.

	(while do): Added cross references to standard list mapping
	functions and SRFI-1, which contains many more.

2003-05-30  Stephen Compall  <s11@member.fsf.org>

	* scheme-control.texi: More index entries.

	(while do): Changed some sentences from passive to active voice,
	as RMS recommends.

	(begin): Showed results of `begin'.

	(and or): Examples of using `and' and `or' as tests in `if'.

2003-05-13  Stephen Compall  <s11@member.fsf.org>

	* scheme-control.texi (begin): Added note about begin's
	uselessness.

	(if cond case): Added note about else usage in cond.

	Referred to else as a literal symbol, not keyword.

	(while do): Moved named let to beginning of iteration mechanisms,
	to reflect its relative importance better.

	Added working example of named let to its section, and how to use
	it in place of the other provided iteration mechanisms.

	(Multiple Values): Changed @example blocks to use @lisp or
	@smalllisp.

	Fixed result indication in call-with-values example.

	(Exceptions): Defined non-local jump.

	Used @table instead of @example for program flow chart.

	(Exception Terminology): Added cross-reference.

	(Throw): Removed warning of nonexistent "difficulty".

	(Lazy Catch): Clarified similarity to catch.

	Untabified.

	Various English syntax fixes, such as fixing pluralities and
	closing parentheses.

	A conservative sprinkling of Concept Index entries.

--
Stephen Compall or S11 or sirian

Give a small boy a hammer and he will find that everything he encounters
needs pounding.


_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://mail.gnu.org/mailman/listinfo/bug-guile


^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [DOCPATCH]Revamp of doc/ref/scheme-control.texi
  2003-07-16 17:37 [DOCPATCH]Revamp of doc/ref/scheme-control.texi Stephen Compall
@ 2003-07-17 22:50 ` Kevin Ryde
  2003-07-18 17:14   ` Stephen Compall
  2003-07-23 23:53 ` Kevin Ryde
  1 sibling, 1 reply; 7+ messages in thread
From: Kevin Ryde @ 2003-07-17 22:50 UTC (permalink / raw)
  Cc: bug-guile

Stephen Compall <s11@member.fsf.org> writes:
>
> 	(Continuations): Tried to explain them, and created full, useful,
> 	working example.

I posted a rewrite of this section to guile-devel last week, if you
want to compare.  (Subject "doco continuations".)

I hadn't attempted to redo the example, mainly because I couldn't
think of something that wasn't simply a loop or state machine in
disguise.


_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://mail.gnu.org/mailman/listinfo/bug-guile


^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [DOCPATCH]Revamp of doc/ref/scheme-control.texi
  2003-07-17 22:50 ` Kevin Ryde
@ 2003-07-18 17:14   ` Stephen Compall
  2003-07-18 23:38     ` Kevin Ryde
  0 siblings, 1 reply; 7+ messages in thread
From: Stephen Compall @ 2003-07-18 17:14 UTC (permalink / raw)
  Cc: bug-guile

For your convenience, the URL is:
http://mail.gnu.org/archive/html/guile-devel/2003-07/msg00016.html

Kevin Ryde <user42@zip.com.au> writes:
> I posted a rewrite of this section to guile-devel last week, if you
> want to compare.  (Subject "doco continuations".)
> 
> I hadn't attempted to redo the example, mainly because I couldn't
> think of something that wasn't simply a loop or state machine in
> disguise.

1. IMHO, your explanation is better (albeit not as concise ;).  Do you
   want me to work this in and repost my patch, or would you rather do
   it?

2. About the example: if you think it's too obvious, here's an idea: A
   function performs a number of tests.  When a test fails, it throws
   an error, with REST (see the errors node) being the current
   continuation.  This gives the calling function an opportunity to
   report the error, or hopefully fix it, and then resume executing
   the testing function.  You could emulate it with closures, sure,
   but....

3. The above idea was one for another list: some "nifty" things you
   can do with continuations.  That is, as it is now, it vaguely
   refers to situations in which call/cc may be preferable, without
   explaining at least one of those situations.

--
Stephen Compall or s11 or sirian

You know the great thing about TV?  If something important happens
anywhere at all in the world, no matter what time of the day or night,
you can always change the channel.
		-- Jim Ignatowski


_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://mail.gnu.org/mailman/listinfo/bug-guile


^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [DOCPATCH]Revamp of doc/ref/scheme-control.texi
  2003-07-18 17:14   ` Stephen Compall
@ 2003-07-18 23:38     ` Kevin Ryde
  0 siblings, 0 replies; 7+ messages in thread
From: Kevin Ryde @ 2003-07-18 23:38 UTC (permalink / raw)
  Cc: bug-guile

Stephen Compall <s11@member.fsf.org> writes:
>
> 1. Do you
>    want me to work this in and repost my patch, or would you rather do
>    it?

I'll probably checkin what I did, and let you propose more on
guile-devel.

> 3. The above idea was one for another list: some "nifty" things you
>    can do with continuations.  That is, as it is now, it vaguely
>    refers to situations in which call/cc may be preferable, without
>    explaining at least one of those situations.

There might not be many realistic cases where continuations are
better, not with the way they're implemented.  I'm inclined to just
ensure the description has all the facts, and leave it at that.


_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://mail.gnu.org/mailman/listinfo/bug-guile


^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [DOCPATCH]Revamp of doc/ref/scheme-control.texi
  2003-07-16 17:37 [DOCPATCH]Revamp of doc/ref/scheme-control.texi Stephen Compall
  2003-07-17 22:50 ` Kevin Ryde
@ 2003-07-23 23:53 ` Kevin Ryde
  2003-07-24 19:14   ` Stephen Compall
  1 sibling, 1 reply; 7+ messages in thread
From: Kevin Ryde @ 2003-07-23 23:53 UTC (permalink / raw)
  Cc: bug-guile

Stephen Compall <s11@member.fsf.org> writes:
>
> I was planning on saving this until I could get all the way through
> the file, but it's getting a little unwieldy, so please have a look.
> ChangeLog at the bottom of this email.

It'll be easier to review if you post independent changes separately,
showing the new text.

> 	* scheme-control.texi (while do): Continue converting to active
> 	voice.

I wouldn't worry about that sort of thing, not unless it's really
unclear.

> 	* scheme-control.texi (begin): Added note about begin's
> 	uselessness.

Well, it's only sometimes not required.  If you want to add something,
then perhaps a typical use in an `if'.

> 	Untabified.
> 	Fixed result indication in call-with-values example.

Thanks, I applied these bits.


_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://mail.gnu.org/mailman/listinfo/bug-guile


^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [DOCPATCH]Revamp of doc/ref/scheme-control.texi
  2003-07-23 23:53 ` Kevin Ryde
@ 2003-07-24 19:14   ` Stephen Compall
  2003-07-25 22:37     ` Kevin Ryde
  0 siblings, 1 reply; 7+ messages in thread
From: Stephen Compall @ 2003-07-24 19:14 UTC (permalink / raw)
  Cc: bug-guile

Kevin Ryde <user42@zip.com.au> writes:
> It'll be easier to review if you post independent changes separately,
> showing the new text.

Agreed.

> > 	* scheme-control.texi (while do): Continue converting to active
> > 	voice.
> 
> I wouldn't worry about that sort of thing, not unless it's really
> unclear.

I don't know about that, but the named let section and do section were
suddenly much clearer after I converted them.  I suppose those two
would qualify for that criteria, but I seem only able to tell in
hindsight, that is after changing the voice, and it is *always* an
improvement.  That's why I just swept the text.

> > 	* scheme-control.texi (begin): Added note about begin's
> > 	uselessness.
> 
> Well, it's only sometimes not required.  If you want to add something,
> then perhaps a typical use in an `if'.

Just kidding :)

> > 	Untabified.
> > 	Fixed result indication in call-with-values example.
> 
> Thanks, I applied these bits.

I assume you want me to repropose the remainder of the changes on
guile-devel, as suggested earlier?

--
Stephen Compall or s11 or sirian

The study of non-linear physics is like the study of non-elephant biology.

BROMURE national information infrastructure Indigo event security
clandestine nuclear benelux Soviet Capricorn e-cash Roswell
Leuken-Baden AVN quarter bemd



_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://mail.gnu.org/mailman/listinfo/bug-guile


^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [DOCPATCH]Revamp of doc/ref/scheme-control.texi
  2003-07-24 19:14   ` Stephen Compall
@ 2003-07-25 22:37     ` Kevin Ryde
  0 siblings, 0 replies; 7+ messages in thread
From: Kevin Ryde @ 2003-07-25 22:37 UTC (permalink / raw)
  Cc: bug-guile

Stephen Compall <s11@member.fsf.org> writes:
>
> I don't know about that, but the named let section and do section were
> suddenly much clearer after I converted them.

Those bits aren't too terrible but could probably stand a bit of
polish.  Something in point form might clarify what happens in `do'.

> I assume you want me to repropose the remainder of the changes on
> guile-devel, as suggested earlier?

Typos can go in immediately, the rest will need copyright paperwork.
Yes, guile-devel is the best place to get feedback.  Make sure your
diffs are against the current cvs, for easy of applying.


_______________________________________________
Bug-guile mailing list
Bug-guile@gnu.org
http://mail.gnu.org/mailman/listinfo/bug-guile


^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2003-07-25 22:37 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2003-07-16 17:37 [DOCPATCH]Revamp of doc/ref/scheme-control.texi Stephen Compall
2003-07-17 22:50 ` Kevin Ryde
2003-07-18 17:14   ` Stephen Compall
2003-07-18 23:38     ` Kevin Ryde
2003-07-23 23:53 ` Kevin Ryde
2003-07-24 19:14   ` Stephen Compall
2003-07-25 22:37     ` Kevin Ryde

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).