Skip to content

Commit f5e28fe

Browse files
author
Amanda Butler
authored
Edit mbed_wait_api.h
Standardize unit of time measurements, and change passive to active voice.
1 parent 957f240 commit f5e28fe

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

platform/mbed_wait_api.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ extern "C" {
5656
*
5757
* @note
5858
* If the RTOS is present, this function spins to get the exact number of microseconds for
59-
* usec precision upto 10msec. If delay is larger then 10msec and not in ISR, it is same as
60-
* `wait_ms`. `wait_us` and `wait_ms` are recommended over `wait`
59+
* microsecond precision up to 10 milliseconds. If delay is larger than 10 milliseconds and not in ISR, it is the same as
60+
* `wait_ms`. We recommend `wait_us` and `wait_ms` over `wait`.
6161
*/
6262
void wait(float s);
6363

@@ -77,8 +77,8 @@ void wait_ms(int ms);
7777
*
7878
* @note
7979
* This function always spins to get the exact number of microseconds.
80-
* If RTOS is present, this will affect power (prevents deep sleep) and
81-
* multithread performance, hence spinning for milli-sec wait is not recommended.
80+
* If RTOS is present, this will affect power (by preventing deep sleep) and
81+
* multithread performance. Therefore, spinning for millisecond wait is not recommended.
8282
*/
8383
void wait_us(int us);
8484

0 commit comments

Comments
 (0)