Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update VirtualizedList component #29707

Closed

Conversation

ani4aniket
Copy link
Contributor

Fixes MLH-Fellowship#220

Summary

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 the 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

  • Update the title and prop description from docs.
  • Remove unnecessary * from the code comments.
  • Add Snack player example specified in the docs to the code comments as JSDoc.
  • Add @type annotation to parse supported datatype by the prop.
  • Add @platform annotation to specify platforms supported by a prop.
  • Add @default annotation to parse default value of prop.

Changelog

[Internal]

Test Plan

All changes are made to the code comments and thus there is no need for testing.

Reviewed by @jevakallio

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 20, 2020
@ani4aniket ani4aniket force-pushed the components/VirtualizedList branch from f95d72f to d480ccd Compare August 20, 2020 06:17
@analysis-bot
Copy link

Platform Engine Arch Size (bytes) Diff
android hermes arm64-v8a 7,003,058 7
android hermes armeabi-v7a 6,666,661 18
android hermes x86 7,423,383 45
android hermes x86_64 7,314,273 24
android jsc arm64-v8a 9,162,926 25
android jsc armeabi-v7a 8,818,650 24
android jsc x86 9,011,324 41
android jsc x86_64 9,588,414 28

Base commit: f8e5423

@analysis-bot
Copy link

Platform Engine Arch Size (bytes) Diff
ios - universal n/a --

Base commit: f8e5423

@charlesbdudley charlesbdudley self-assigned this Aug 13, 2021
@charlesbdudley
Copy link
Contributor

charlesbdudley commented Aug 16, 2021

Thanks for this contribution, @ani4aniket, and apologies for not getting around to it until now. This MLH-Fellowship project is not currently being worked on so we're going to close this PR to focus on active ones. If you feel this is an error or if you'd like to pick this up again, please let me know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the VirtualizedList component
4 participants