Skip to content

Platform docs cleanup #482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 10, 2018

Conversation

theotherjimmy
Copy link
Contributor

  • Break platform into 3 major sections
  • Introcude relevent concetps in those sections
  • Move detailed exampes into Callback docs

 - Break platform into 3 major sections
 - Introcude relevent concetps in those sections
 - Move detailed exampes into Callback docs
@theotherjimmy theotherjimmy changed the title WIP platform docs cleanup Platform docs cleanup Apr 4, 2018
@theotherjimmy
Copy link
Contributor Author

@AnotherButler I think I got to all of the cleanup I needed to.

@theotherjimmy
Copy link
Contributor Author

@sg- Could you take a look?

Copy link
Contributor

@sg- sg- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good but one or two small changes needed

@@ -27,3 +27,156 @@ Here is an example that uses everything discussed in the [introduction to callba

- [Platform overview](/docs/development/reference/platform.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and Intro + related content should now be deleted

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I'll do that.

You can create a Callback directly from a C function or function pointer with the same type:

``` c++
void dosomething(int) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great to move the content around but this still violates the no foo/bar rule imo. Make sure to keep another task to make the example useful or tangible

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'd rather just do that now.

@theotherjimmy
Copy link
Contributor Author

@sg- Could you take another look?

Copy link
Contributor

@sg- sg- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done 👍

Make minor grammar changes.
@AnotherButler AnotherButler merged commit 70bb851 into ARMmbed:new_engine Apr 10, 2018
AnotherButler pushed a commit that referenced this pull request Apr 10, 2018
Make change from #482 to live site.
AnotherButler pushed a commit that referenced this pull request Apr 10, 2018
Add content from #482 to live site.
AnotherButler pushed a commit that referenced this pull request Apr 10, 2018
Make changes from #482 to live site.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants