reactjs / reactjs/react-docgen
Flow's @platform attribute treated as part of the description
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
/**
* TV next focus down (see documentation for the View component).
*
* @platform android
*/
nextFocusDown?: ?number,
gets captured as:
"nextFocusDown": {
"required": false,
"flowType": {
"name": "number",
"nullable": true
},
"description": "TV next focus down (see documentation for the View component).\n\n@platform android"
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing extraction from the React Native Button.js example, then trace how the Flow docblock is parsed. Done means the @platform android annotation is no longer included in the property's description and the extracted result matches the intended metadata behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react-native
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100