Update the button component #18
Open
Conversation
This file contains hidden or 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
ayushjainrksh
commented
Jun 11, 2020
|
@ayushjainrksh I started a review but have to jump off and continue later. Posted few comments, more to follow |
Member
Author
|
Okay, no problem. |
jevakallio
requested changes
Jun 12, 2020
jevakallio
left a comment
jevakallio
left a comment
There was a problem hiding this comment.
Overall looking good! We need to change the multiline comment format, and get a decision from Moti regarding the default props annotations, but after those this is good to go
ayushjainrksh
commented
Jun 12, 2020
jevakallio
reviewed
Jun 16, 2020
jevakallio
approved these changes
Jun 16, 2020
jevakallio
left a comment
jevakallio
left a comment
There was a problem hiding this comment.
LGTM! One minor question in line notes
* Update the title and prop description from docs. * Add default value to props. * Update platforms in props with platform annotation.. * Remove asterisks from the comments. * Add snack player and update multiple platform format. * Add example annotation to snackplayer
ayushjainrksh
force-pushed
the
components/button
branch
from
759463f to
5147bb0
Compare
ayushjainrksh
force-pushed
the
components/button
branch
from
a05efc6 to
cc92ab4
Compare
facebook-github-bot
pushed a commit
to facebook/react-native
that referenced
this pull request
Aug 4, 2020
Summary: Fixes MLH-Fellowship#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: #29155 Test Plan: All changes are made to the code comments and thus there is no need for testing. [Reviewed by jevakallio](MLH-Fellowship#18) Reviewed By: cpojer Differential Revision: D22767877 Pulled By: motiz88 fbshipit-source-id: ccad8d58dc2888d44d34fdbb94b3c187542e9f2b
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.
Fixes #33
Summary
*from the code comments.An attempt to solve the problem of specifying the default value of a prop in a component.I added the default values to the props whiledestructuringtheir actual values.This would not only help the docs to get the default prop value(when automated) but also reduce hardcoded styles/values in the code.@defaultannotation.@default {@platform android/ios}.@platformdecorator.@exampleannotation.