Add platform/Span documentation. #683
Merged
Conversation
This file contains 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
|
@donatieng Could you review ? |
Copy edit, mostly for active voice.
| ### Span class reference | ||
|
|
||
| [](https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_span.html) | ||
|
|
There was a problem hiding this comment.
Please add an example.
donatieng
suggested changes
Aug 28, 2018
docs/reference/api/platform/Span.md
Outdated
|
|
||
| Span<uint8_t> first_half = str_span.first(half_size); | ||
| Span<uint8_t> second_half = str_span.last(half_size); | ||
| Span<uint8_t> middle_half = str_span.subspan(/* offset */ half_size / 2, half_size); |
There was a problem hiding this comment.
middle_half sounds a bit weird to me
|
@pan- Please address the comments from @donatieng |
|
@pan- Question: why do all code snippets show uint8_t ? why not other bit lengths? not supported yet or these are just examples? |
|
@ashok-rao Any type is supported, it is just for examples purposes. |
|
@donatieng I fixed your issue. |
donatieng
approved these changes
Aug 30, 2018
AnotherButler
approved these changes
Aug 30, 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.
This is the associated documentation PR for ARMmbed/mbed-os#7828.