#206 closed Bug (No Bug)
Sleep Documentation Incorrect
| Reported by: | maroesjk | Owned by: | |
|---|---|---|---|
| Milestone: | Component: | Documentation | |
| Version: | 3.2.10.0 | Severity: | |
| Keywords: | Sleep | Cc: |
Description
The documentation of the function Sleep( delay ) is incorrect. It states that the return value is "none", but actually it is "1". This may be important for usage in scripts.
Attachments (0)
Change History (3)
comment:1 Changed 17 years ago by TicketCleanup
- Milestone Future Release deleted
comment:2 Changed 17 years ago by Valik
- Resolution set to No Bug
- Status changed from new to closed
You are missing the point. All functions must return a value, so no function returns a value of "none". But the point is, the return value is not clearly defined. We do not guarantee Sleep() will return 1. If you choose to rely on this value, you do so at your own risk that at some point we may change the value. Hence, the return value is not documented.
comment:3 Changed 17 years ago by maroesjk
Wouldn't it be better if the documentation stated that the return value is "undefined", "undocumented" or something instead of "none". Apparently "none" might lead to misunderstandings...
Guidelines for posting comments:
- You cannot re-open a ticket but you may still leave a comment if you have additional information to add.
- In-depth discussions should take place on the forum.
For more information see the full version of the ticket guidelines here.
Automatic ticket cleanup.