recoilphp / recoil

Asynchronous coroutines for PHP 7.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Document API call 'cooperation' guarantees.

jmalloc opened this issue · comments

Not all API operations are 'cooperative'. That is, even though you use the yield keyword to call them, they don't necessarily "yield" CPU time to other strands.

The doc-blocks of each method should state its guarantees (and if possible, functional tests should verify the guarantees).

@koden-km This is probably another good 'lern2recoil' one.

This is done in the Recoil facade in recoil/api.