summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRémi Verschelde <remi@verschelde.fr>2021-02-19 15:14:36 +0100
committerGitHub <noreply@github.com>2021-02-19 15:14:36 +0100
commitefddb8a0cbf2656100bbde6539739e18f259740d (patch)
treea1d074a9634bff91fdefaf324ec7661749b47ccf /doc/classes
parentbc395c2549009d28cdb8884f4beeebe7250de9f5 (diff)
parent76f1f9b3c56afff2aa144468d8e33f590d6822cd (diff)
Merge pull request #46194 from Calinou/os-delay-no-negative
Don't allow negative values for `OS.delay_usec()`/`OS.delay_msec()`
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/OS.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index ffcd0d4c98..f6602d5f4d 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -54,7 +54,7 @@
<argument index="0" name="msec" type="int">
</argument>
<description>
- Delay execution of the current thread by [code]msec[/code] milliseconds.
+ Delay execution of the current thread by [code]msec[/code] milliseconds. [code]usec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_msec] will do nothing and will print an error message.
</description>
</method>
<method name="delay_usec" qualifiers="const">
@@ -63,7 +63,7 @@
<argument index="0" name="usec" type="int">
</argument>
<description>
- Delay execution of the current thread by [code]usec[/code] microseconds.
+ Delay execution of the current thread by [code]usec[/code] microseconds. [code]usec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_usec] will do nothing and will print an error message.
</description>
</method>
<method name="dump_memory_to_file">