Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs: Updated iOS Component Guide #14991

Closed
wants to merge 2 commits into from
Closed

Docs: Updated iOS Component Guide #14991

wants to merge 2 commits into from

Conversation

teameh
Copy link
Contributor

@teameh teameh commented Jul 12, 2017

Follow up on #14436

@hramos:

MapViewIOS was removed a couple of versions ago. No one has touched this guide in a while, so unless someone volunteers to get it back up to date, we'll probably end up removing it from the docs.

I'm volunteering to get it back up to date!

  • Fixed broken code examples
  • Swapped out pitchEnabled for zoomEnabled, needs less explaining and it's easier to test on a simulator.
  • Renamed RNTMap to RNTMapView for clarity.
  • Renamed inconsistent onChanges to onRegionChange`.
  • Swapped out 'vending' for 'exposing'.

I wasn't really sure about the last 3 points. I think it's more clear like this, but please review.

I'll add some review comments as well.

@teameh teameh requested a review from hramos as a code owner July 12, 2017 23:46
@facebook-github-bot facebook-github-bot added CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. GH Review: review-needed labels Jul 12, 2017
teameh
teameh commented Jul 12, 2017
View reviewed changes
docs/NativeComponentsIOS.md
```

Make sure to use `RNTMap` here. We want to require the manager here, which will expose the view of our manager for use in Javascript.
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 thought this could use some more clarification.

#12853
#3575

docs/NativeComponentsIOS.md Outdated

#import "RNTMapManager.h"
```objectivec{9,17,31-48}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does objectivec{9,17,31-48} creates a highlight for the ReactNative docs as well?

docs/NativeComponentsIOS.md
this._onChange = this._onChange.bind(this);
}
_onChange(event: Event) {
_onRegionChange = (event) => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed typehint (since none of the other code is using it). And removed the ugly .bind(this). Not sure if this is okay in the sample code, please review.

Copy link
Contributor

Choose a reason for hiding this comment

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

It's alright.

hramos
hramos approved these changes Jul 13, 2017
View reviewed changes
Copy link
Contributor

@hramos hramos left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! This is a great example of the community stepping in to give some love to the docs.

@facebook-github-bot facebook-github-bot added GH Review: accepted Import Started This pull request has been imported. This does not imply the PR has been approved. and removed GH Review: review-needed labels Jul 13, 2017
@facebook-github-bot
Copy link
Contributor

@hramos has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@facebook-github-bot
Copy link
Contributor

I tried to merge this pull request into the Facebook internal repo but some checks failed. To unblock yourself please check the following: Does this pull request pass all open source tests on GitHub? If not please fix those. Does the code still apply cleanly on top of GitHub master? If not can please rebase. In all other cases this means some internal test failed, for example a part of a fb app won't work with this pull request. I've added the Import Failed label to this pull request so it is easy for someone at fb to find the pull request and check what failed. If you don't see anyone comment in a few days feel free to comment mentioning one of the core contributors to the project so they get a notification.

@facebook-github-bot facebook-github-bot added Import Failed and removed Import Started This pull request has been imported. This does not imply the PR has been approved. labels Jul 14, 2017
@teameh
Copy link
Contributor Author

teameh commented Jul 14, 2017 •
edited

@hramos

Thanks for doing this! This is a great example of the community stepping in to give some love to the docs.

You're welcome! Would be great to contribute a bit more in the next months.

@facebook-github-bot

Does this pull request pass all open source tests on GitHub?

Yeah ✅

Does the code still apply cleanly on top of GitHub master?

Rebased just to be sure ✅

@hramos
Copy link
Contributor

hramos commented Jul 14, 2017

Investigating.

@facebook-github-bot facebook-github-bot added the Import Started This pull request has been imported. This does not imply the PR has been approved. label Jul 14, 2017
@facebook-github-bot
Copy link
Contributor

@hramos has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

1 similar comment
@facebook-github-bot
Copy link
Contributor

@hramos has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@facebook-github-bot
Copy link
Contributor

@hramos has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@teameh teameh deleted the ios-component-guide branch July 20, 2017 08:06
@teameh
Copy link
Contributor Author

teameh commented Jul 20, 2017

Great! Thanks @hramos!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hramos hramos hramos approved these changes

Assignees
No one assigned
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. Import Started This pull request has been imported. This does not imply the PR has been approved.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@teameh @facebook-github-bot @hramos @shergin