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.

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

Update Switch component #29546

Closed
wants to merge 1 commit into from

Conversation

ani4aniket
Copy link
Contributor

Fixes MLH-Fellowship#60

Summary

The PR is part of an effort to update the code comments to match the current documentation on the React Native website. The project is a part of the MLH Fellowship program and involves the automatic generation of the website docs from code comments and flow types as the end result.

To learn more about the project you can visit the project wiki:

Link to the documentation(the source of truth):

Changes

  • Update the title and prop description from docs.
  • Remove unnecessary * from the code comments.
  • Add Snack player example specified in the docs to the code comments as JSDoc.
  • Add @type annotation to parse supported datatype by the prop.
  • Add @platform annotation to specify platforms supported by a prop.
  • Add @default annotation to parse default value of prop.

Changelog

[Internal]

Test Plan

All changes are made to the code comments and thus there is no need for testing.

Reviewed by @jevakallio

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 1, 2020
@analysis-bot
Copy link

Platform Engine Arch Size (bytes) Diff
android hermes arm64-v8a 6,765,205 -2,144
android hermes armeabi-v7a 6,428,440 -5,536
android hermes x86 7,152,361 -2,975
android hermes x86_64 7,042,325 -2,744
android jsc arm64-v8a 8,938,481 504
android jsc armeabi-v7a 8,594,092 -2,886
android jsc x86 8,768,742 -321
android jsc x86_64 9,344,357 -79

Base commit: f8f53e5

@analysis-bot
Copy link

Platform Engine Arch Size (bytes) Diff
ios - universal n/a --

Base commit: f8f53e5

@ani4aniket
Copy link
Contributor Author

@motiz88 Updated Switch component as of RN0.63.
Latest synced markdown with our script for Switch https://reactnativedocs.netlify.app/docs/next/switch

@motiz88 motiz88 self-requested a review August 4, 2020 11:55
Copy link
Contributor

@facebook-github-bot facebook-github-bot left a comment

Choose a reason for hiding this comment

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

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

@react-native-bot
Copy link
Collaborator

This pull request was successfully merged by @ani4aniket in 44cb09a.

When will my fix make it into a release? | Upcoming Releases

@react-native-bot react-native-bot added the Merged This PR has been merged. label Aug 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. Merged This PR has been merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the Switch component
5 participants