Update the Modal component #64
Open
Conversation
This file contains 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 22, 2020
| * | ||
| * See https://reactnative.dev/docs/modal.html | ||
| */ | ||
|
|
There was a problem hiding this comment.
Moved the updated comments directly above the declared component so that it can be parsed by react-docgen.
Libraries/Modal/Modal.js
Outdated
| events will not be emitted as long as the modal is open. | ||
|
|
||
| @type {@platform android, Platform.isTVOS}{@required yes} function | ||
| @type {@platform (others)}{@required no} function |
There was a problem hiding this comment.
Point of discussion
The required parameter changes with the platform used.
Screenshot
9cafa0b to
627286d
Compare
ayushjainrksh
commented
Jun 25, 2020
Libraries/Modal/Modal.js
Outdated
| | Type | Required | Platform | | ||
| | -------- | -------- | ------------------------ | | ||
| | function | Yes | Android, Platform.isTVOS | | ||
| | function | No | (Others) | |
There was a problem hiding this comment.
@jevakallio As a special case I added the whole markdown table. How does this look?
There was a problem hiding this comment.
Parsing the table from description works but we cannot get rid of the autogenerated table.
* Update the title and prop description from docs. * Remove asterisks from the comments. * Add snackplayer example. * Add platform annotation for platfroms. * Cap comments to 80 characters and add annotations
bb2e334 to
b3c016b
Compare
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 #63
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 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
Changelog
[General] [Changed] - Update the code comments in
modal.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.