Use template for sleep PG #390
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
0xc0170
approved these changes
Jan 31, 2018
Copy edit document for active voice, consistent tense and inclusion of articles.
Copy edit for active voice and complete sentences.
There was a problem hiding this comment.
@bulislaw Could you please help me find the correct links in the feature branch Doxygen?
https://os.mbed.com/docs/v5.7/feature-hal-spec-sleep-doxy/annotated.html
| To enable sleep support in Mbed OS, you need to add the `SLEEP` label in the `device_has` option of the target's section in the `targets.json` file. | ||
| You can read more about the test cases: | ||
|
|
||
| [](https://github.com/ARMmbed/mbed-os/blob/feature-hal-spec-sleep/TESTS/mbed_hal/sleep/sleep_api_tests.h) |
There was a problem hiding this comment.
I can't find this in the feature branch Doxygen.
| ``` | ||
| 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: | ||
|
|
||
| [](https://github.com/ARMmbed/mbed-os/blob/feature-hal-spec-sleep/hal/sleep_api.h) |
There was a problem hiding this comment.
I can't find this in the feature branch Doxygen.
Delete section title from empty section.
Fix confusing sentence by adding missing word.
AnotherButler
approved these changes
Feb 27, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the Sleep PG to match the HAL template.
@AnotherButler we still need to correct the links to point out to doxy for feature branches when available.