&emit and &done undocumented

[zoffixznet]

The subroutine emit doesn't seem to be documented. Only methods on various classes listed in https://docs.perl6.org/routine/emit

[jonathanstowe]

Presumably the same applies to done - I actually thought they were inserted into the scope of the supply { } or react { } and didn't have a separate existence. However they may not want to be documented standalone but rather as part of the asynchronous mini language ....

[jnthn]

They are normal subroutines that throw control exceptions, just like take and last.

[jonathanstowe]

yeah I realised that after I looked at the souce, however if they are documented as being standalone subroutines then there will need to be a load of boilerplate explaining how they only work in a certain context, so to avoid that it might be better to treat them as if they were special syntactical items (in my mind at least.)

[zoffixznet]

a load of boilerplate explaining how they only work in a certain context

Wouldn't it be just a single sentence? Just like with take: https://docs.perl6.org/routine/take

[JJ]

Where would that go?

[AlexDaniel]

@JJ I was about to say “same place where &done is documented”, but it seems that sub &done is not documented also…

[AlexDaniel]

Maybe somewhere on https://docs.perl6.org/language/functions?

[JJ]

We need to fix this "not documented" thing using code... Maybe create a test or something. They stay open for ever, even when they are fixed.
But functions would be a good place.

[JJ]

Functions would not be a good place. It's mainly devoted to functional programming. So I'm starting a brand new page, This will help #2059 too.

[JJ]

&emit is done, &done is not. I'm reopening to do it.