Opened on Apr 7, 2008 at 10:59:04 AM
Closed on Apr 7, 2008 at 3:00:20 PM
Last modified on May 6, 2008 at 4:28:43 PM
#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 by , on Apr 7, 2008 at 12:00:37 PM
| Milestone: | Future Release |
|---|
comment:2 by , on Apr 7, 2008 at 3:00:20 PM
| Resolution: | → No Bug |
|---|---|
| Status: | new → 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 by , on May 6, 2008 at 4:28:43 PM
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...
Automatic ticket cleanup.