replacetext

[Jeanne A. E. DeVoto]

At 5:40 PM -0800 1/18/2002, Bob Rasmussen wrote:
>To Rev documentation folks:
>
>Given the subtle distinction between commands and functions, I think
>it would be a good idea in the Rev documentation to give examples
>only of usage in proper context.  That is, please don't show functions
>alone on a line in a way that makes them look like commands.

I've thought about doing this, especially since the problem has cropped up
on the list twice now. The problem with it is that embedding the function
in a complete statement makes it more complicated - especially when the
function call itself is complex, I'm concerned about it causing confusion.

Of course, I could just stick "get" in front of all the examples, but that
doesn't always make a statement you'd actually use in a real-world handler.
And I'm a little concerned about new developers getting the impression that
"get" is the only way to use a function, as opposed to using it in a
conditional, etc.

Does anyone else have an opinion about this? Any other ways to make it
crystal clear that a function can't be used as a complete statement, and
avoid confusing people?

--
Jeanne A. E. DeVoto ~ jeanne at runrev.com
http://www.runrev.com/
Runtime Revolution Limited - Power to the Developer!