Update the KeyboardAvoidingView component#48
Open
ayushjainrksh wants to merge 2 commits intomasterfrom
Open
Conversation
* Update the title and prop description from docs. * Remove asterisks from the comments. * Add snackplayer example with example annotation. * Add inherit annotation for inherited component.
ayushjainrksh
commented
Jun 18, 2020
| /** | ||
| * Controls whether this `KeyboardAvoidingView` instance should take effect. | ||
| * This is useful when more than one is on the screen. Defaults to true. | ||
| Enabled or disabled KeyboardAvoidingView. The default is `true`. |
Member
Author
There was a problem hiding this comment.
The default value is given in the description in the documentation(the source of truth). I would suggest removing it from the description and adding a @default annotation for default value to keep it consistent. Or we can keep both and later remove it.
| * Distance between the top of the user screen and the React Native view. This | ||
| * may be non-zero in some cases. Defaults to 0. | ||
| This is the distance between the top of the user screen and the react native view, | ||
| may be non-zero in some use cases. Defaults to 0. |
Member
Author
There was a problem hiding this comment.
Same as above (the default value).
jevakallio
approved these changes
Jun 24, 2020
jevakallio
left a comment
jevakallio
left a comment
There was a problem hiding this comment.
LGTM. I'm ok with making the @default changes either now, or logging them for a big mass refactor later.
Member
Author
|
Okay, let's focus on our primary objective to write the script now and we'll come back to this later. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 #47
Summary
The PR is towards fixing the documentation of the Components in react-native by updating the code comments in synchronisation with the actual documentation(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:
Link to the documentation(the source of truth):
Changes
*from the code comments.@exampleannotation.Changelog
[General] [Changed] - Update the code comments in
keyboardavoidingview.jsto synchronise with the react native documentation.Test Plan
All changes are made to the code comments and thus there is no need for testing.