Modify

Opened 18 years ago

Closed 18 years ago

Last modified 18 years ago

#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 TicketCleanup, 18 years ago

Milestone: Future Release

Automatic ticket cleanup.

comment:2 by Valik, 18 years ago

Resolution: No Bug
Status: newclosed

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 maroesjk, 18 years ago

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...

Modify Ticket

Action
as closed The ticket will remain with no owner.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.