Documentation: $262.agent.report() is expected to convert its argument to a string.

Fixes #1640
Closes #1652
This commit is contained in:
Rick Waldron 2018-07-30 11:50:14 -04:00 committed by Leo Balter
parent 24f861721f
commit aba414caad
1 changed files with 2 additions and 3 deletions

View File

@ -86,9 +86,8 @@ properties of the global scope prior to test execution.
an Int32. This function may return before a broadcast is received an Int32. This function may return before a broadcast is received
(eg to return to an event loop to await a message) and no code should (eg to return to an event loop to await a message) and no code should
follow the call to this function. follow the call to this function.
- **`report`** - a function that takes a string and places it in a - **`report`** - a function that accepts a single "message" argument,
transmit queue whence the parent will retrieve it. Messages which is converted to a string\* and placed in a transmit queue whence the parent will retrieve it. Messages should be short. (\* Note that string conversion has been implicit since the introduction of this host API, but is now explicit.)
should be short.
- **`sleep`** - a function that takes a millisecond argument and - **`sleep`** - a function that takes a millisecond argument and
sleeps the agent for approximately that duration. sleeps the agent for approximately that duration.
- **`leaving`** - a function that signals that the agent is done and - **`leaving`** - a function that signals that the agent is done and