mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Ayush JainandFacebook GitHub Bot
6b7014ab04
Summary: Fixes https://github.com/MLH-Fellowship/react-native/issues/33 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 MLH fellowship program and involves 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: - [Project details](https://github.com/MLH-Fellowship/0.4.x-projects/wiki/React-Native-Flowtype-API-Docs-Generator) - [RN Docs Standards](https://github.com/MLH-Fellowship/react-native/wiki/RN-Docs-standards) Link to the documentation(the source of truth): - [button.md](https://github.com/MLH-Fellowship/react-native-website/blob/master/docs/button.md) ## Changes * Update the title and prop description from docs. * Remove unnecessary `*` from the code comments. * Add default value to props. * Specify the default value of a prop in the code comments with `default` annotation. * For multiple defaults (different devices) use `default {platform android/ios}`. * Update platforms in props. * Use comma separated string with `platform` decorator. * Add Snack player example specified in the docs to the code comments with `example` annotation. ## Changelog [Internal] Pull Request resolved: https://github.com/facebook/react-native/pull/29155 Test Plan: All changes are made to the code comments and thus there is no need for testing. [Reviewed by jevakallio](https://github.com/MLH-Fellowship/react-native/pull/18) Reviewed By: cpojer Differential Revision: D22767877 Pulled By: motiz88 fbshipit-source-id: ccad8d58dc2888d44d34fdbb94b3c187542e9f2b