Skip to content

Commit c5c0329

Browse files
author
Amanda Butler
authored
Merge pull request #446 from ARMmbed/Contributing-API-References-Typos
Contr API Ref Typos
2 parents d40266a + 78fb1d7 commit c5c0329

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

docs/reference/contributing/target/lp_ticker.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Implementing the low power ticker enables Mbed OS to perform power efficient tim
1616
- The ticker rolls over at (1 << bits) and continues counting starting from 0.
1717
- The ticker counts at the specified frequency plus or minus 10%.
1818
- The ticker increments by 1 each tick.
19-
- The ticker interrupt fires only when the ticker times increments to or past the value that `ticker_set_interrupt` sets.
19+
- The ticker interrupt fires only when the ticker time increments to or past the value that `ticker_set_interrupt` sets.
2020
- It is safe to call `ticker_set_interrupt` repeatedly before the handler is called.
2121
- The function `ticker_fire_interrupt` causes `ticker_irq_handler` to be called immediately from interrupt context.
2222
- The ticker operations `ticker_read`, `ticker_clear_interrupt`, `ticker_set_interrupt` and `ticker_fire_interrupt` take less than 20us to complete.
@@ -34,19 +34,19 @@ Be careful around these common trouble areas when implementing this API:
3434

3535
- The ticker cannot drift when rescheduled repeatedly
3636
- The ticker keeps counting when it rolls over
37-
- The ticker interrupts fires when the compare value is set to 0 and and overflow occurs
37+
- The ticker interrupt fires when the compare value is set to 0 and and overflow occurs
3838

3939
#### Dependencies
4040

4141
Hardware low power ticker capabilities.
4242

4343
#### Implementing the low power ticker API
4444

45-
We are working on the new HAL low power ticker API, which will replace current version in an upcoming release of Mbed OS. You need to implement the low power ticker API in both variants. First, you need to implement the current API. You can find it on master branch:
45+
We are working on the new HAL low power ticker API, which will replace the current version in an upcoming release of Mbed OS. You need to implement the low power ticker API in both variants. First, you need to implement the current API. You can find it on master branch:
4646

4747
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/lp__ticker__api_8h_source.html)
4848

49-
To make sure your platform is ready for the upcoming changes, you need to implement the future API and submit it in a separate pull request against `feature-hal-spec-ticker` branch. You can find the API and specification for the new low power ticker API in the following header file:
49+
To make sure your platform is ready for the upcoming changes, you need to implement the future API and submit it in a separate pull request against the `feature-hal-spec-ticker` branch. You can find the API and specification for the new low power ticker API in the following header file:
5050

5151
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__lp__ticker.html)
5252

docs/reference/contributing/target/rtc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ Hardware RTC capabilities.
3232

3333
#### Implementing the RTC API
3434

35-
We are working on the new HAL RTC API, which will replace current version in an upcoming release of Mbed OS. You need to implement the RTC API in both variants. First, you need to implement the current API. You can find it on the master branch:
35+
We are working on the new HAL RTC API, which will replace the current version in an upcoming release of Mbed OS. You need to implement the RTC API in both variants. First, you need to implement the current API. You can find it on the master branch:
3636

3737
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/rtc__api_8h_source.html)
3838

39-
To make sure your platform is ready for the upcoming changes, you need to implement the future API and submit it in a separate pull request against `feature-hal-spec-rtc` branch. You can find the API and specification for the new RTC API in the following header file:
39+
To make sure your platform is ready for the upcoming changes, you need to implement the future API and submit it in a separate pull request against the `feature-hal-spec-rtc` branch. You can find the API and specification for the new RTC API in the following header file:
4040

4141
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-rtc-doxy/group__hal__rtc.html)
4242

docs/reference/contributing/target/sleep.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Implement the Sleep HAL API to enable your device to go into a low power state w
88

99
##### Defined behavior
1010

11-
There are two power saving modes available in Mbed OS:
11+
There are two power-saving modes available in Mbed OS:
1212

1313
###### Sleep
1414

@@ -26,11 +26,11 @@ The core system clock is disabled. You can only enable the low-frequency clocks
2626

2727
#### Implementing the Sleep API
2828

29-
We are working on the new HAL Sleep API, which will replace the current version in an upcoming release of Mbed OS. You need to implement the Sleep API in both variants. First, you need to implement the current API. You can find it on master branch:
29+
We are working on the new HAL Sleep API, which will replace the current version in an upcoming release of Mbed OS. You need to implement the Sleep API in both variants. First, you need to implement the current API. You can find it on the master branch:
3030

3131
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/sleep__api_8h_source.html)
3232

33-
To make sure your platform is ready for the upcoming changes, you need to implement the future API and submit it in a separate pull request against `feature-hal-spec-sleep` branch. You can find the API and specification for the new Sleep API in the following header file:
33+
To make sure your platform is ready for the upcoming changes, you need to implement the future API and submit it in a separate pull request against the `feature-hal-spec-sleep` branch. You can find the API and specification for the new Sleep API in the following header file:
3434

3535
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-sleep-doxy/group__hal__sleep.html)
3636

docs/reference/contributing/target/us_ticker.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Microsecond ticker
22

3-
Implementing the microsecond ticker enables Mbed OS to perform operations that require precise timing. You can use this API to shedule events, record elapsed time and perform submillisecond delays.
3+
Implementing the microsecond ticker enables Mbed OS to perform operations that require precise timing. You can use this API to schedule events, record elapsed time and perform submillisecond delays.
44

55
<span class="warnings">**Warning:** We are changing the microsecond ticker HAL API in an upcoming release of Mbed OS. You can find details on how it may affect you in the [implementing the microsecond ticker API](#implementing-the-microsecond-ticker-api) section.
66

@@ -16,7 +16,7 @@ Implementing the microsecond ticker enables Mbed OS to perform operations that r
1616
- The ticker rolls over at (1 << bits) and continues counting starting from 0.
1717
- The ticker counts at the specified frequency plus or minus 10%.
1818
- The ticker increments by 1 each tick.
19-
- The ticker interrupt fires only when the ticker times increments to or past the value set by `ticker_set_interrupt`.
19+
- The ticker interrupt fires only when the ticker time increments to or past the value set by `ticker_set_interrupt`.
2020
- It is safe to call `ticker_set_interrupt` repeatedly before the handler is called.
2121
- The function `ticker_fire_interrupt` causes `ticker_irq_handler` to be called immediately from interrupt context.
2222
- The ticker operations `ticker_read`, `ticker_clear_interrupt`, `ticker_set_interrupt` and `ticker_fire_interrupt` take less than 20us to complete.
@@ -34,19 +34,19 @@ Be careful around these common trouble areas when implementing this API:
3434

3535
- The ticker cannot drift when rescheduled repeatedly
3636
- The ticker keeps counting when it rolls over
37-
- The ticker interrupts fires when the compare value is set to 0 and and overflow occurs
37+
- The ticker interrupt fires when the compare value is set to 0 and overflow occurs
3838

3939
#### Dependencies
4040

4141
To implement this API, the device must have a hardware counter that has a count value at least 16 bits wide and can operate between 250KHz and 8MHz.
4242

4343
#### Implementing the microsecond ticker API
4444

45-
We are working on the new HAL microsecond ticker API, which will replace current version in an upcoming release of Mbed OS. You need to implement the microsecond ticker API in both variants. First, you need to implement the current API. You can find it on master branch:
45+
We are working on the new HAL microsecond ticker API, which will replace the current version in an upcoming release of Mbed OS. You need to implement the microsecond ticker API in both variants. First, you need to implement the current API. You can find it on the master branch:
4646

4747
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/us__ticker__api_8h_source.html)
4848

49-
To make sure your platform is ready for the upcoming changes, you need to implement the future API and submit it in a separate pull request against `feature-hal-spec-ticker` branch. You can find the API and specification for the new microsecond ticker API in the following header file:
49+
To make sure your platform is ready for the upcoming changes, you need to implement the future API and submit it in a separate pull request against the `feature-hal-spec-ticker` branch. You can find the API and specification for the new microsecond ticker API in the following header file:
5050

5151
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-ticker-doxy/group__hal__us__ticker.html)
5252

0 commit comments

Comments
 (0)