For..Until

[sirksel]

I just saw a sentence in the documentation I've never noticed before in a decade of using autohotkey, but apparently has been there since v1:

"Until can be used with any Loop or For" (underline added)

I always knew I could do Loop..Until, but I somehow never realized I could do this:

Code: Select all

a := [2,4,6,8,10]
for i in a
  msgbox i
until i>3

I think I missed it because the For-loop page doesn't mention Until (except as a cross-ref), and the Until page doesn't have an example of it being used with a For-loop. Maybe that might be a good additional example for the docs?

As I'm fixing code for the latest v2 alpha, I'm seeing lots of places to simplify code that currently uses an if/break condition inside the for. Super cool -- the wonders of autohotkey! I'm hoping there are no plans to remove this, now that I'm littering it all throughout 10k lines of code...

[Mod edit: Moved to 'Suggestions on documentation improvements'.]

[kczx3]

Wow... I never saw that either. Neat!

[gregster]

Perhaps more like this, for v1, the index i itself is not that interesting in this case (apart from being the condition):

Code: Select all

a := [2,4,6,8,10]
for i, val in a
  msgbox % i " : " val
until i>3

[swagfag]

literally the first sentence

if ure aching for examples i guess u could replace the enumerator one

Code: Select all

for n in FibF() {
} until MsgBox("#" A_Index " = " n "`nContinue?",, "y/n") = "No"

FibF() {
    a := 0, b := 1
    return (ByRef n) => (
        n := c := b, b += a, a := c,
        true
    )
}

just in case it wasnt ugly enough already

[sirksel]

Right, I get it. I need to learn to read! Anyhow, maybe it's because such a construct doesn't exist with for-loops in several other languages I know... so I read right past those three words?

I guess I wasn't actually proposing my little array snippet as an example for the docs. If you guys go down that road, @gregster's example is much better. Rather, to hit the point home, it might make sense to have the two major variants right up there in the syntax box after the first sentence... one using Loop and one using For, like:

Code: Select all

Loop {
    ...
} Until Expression

For Value1 [, Value2] in Expression {
   ...
} Until Expression

I'm pretty sure I wouldn't have read past it if the syntax box looked like the above. But then again, if you all feel the docs are sufficient, it's OK with me. I'm just a sample size of one, after all. Thanks for your consideration.

[nnnik]

No I think that part you mentioned is a chronical illness of the docs. They are not very useable when topics related to one syntax are found on a random page in the docs.

To fix this we would have to switch our entire documentation system though... So don't expect this to happen anytime soon.