in reply to Re: Docs notation
in thread Docs notation

I saw some documentation the other day:
MouseClick($window [,$parent] [,$x_offset] [,$y_offset] [,$button] [,$ +delay])
A few lines further down there were some examples of usage provided, which showed that if you wanted to specify (eg) $delay, but wanted the default value for the other optional args then you had to:
MouseClick($window, undef, undef, undef, undef, $delay)
To me, that meant the usage should have been presented as something like:
MouseClick($window [,$parent [,$x_offset [,$y_offset [,$button [,$dela +y]]]]])
Not that it matters greatly in this particular instance (as the author had provided examples of usage that clearly demonstrated what was required), but I have some documentation (that needs fixing up) wrt a function that has optional args. And before I fix it up I wanted to get some sort of idea of what that notation actually meant to people - because the more I thought about it, the less certain I became.

I think the main message I draw from these replies is "Be explicit".

Thanks guys.

Cheers,
Rob