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 FlatList doc #12714

Closed
wants to merge 4 commits into from
Closed

Update FlatList doc #12714

wants to merge 4 commits into from

Conversation

sunnylqm
Copy link
Contributor

@sunnylqm sunnylqm commented Mar 5, 2017

  1. Mention scrollToIndex support.
  2. Fix a format error.
  3. Use relative links like
    * [`Navigator`](docs/navigator.html) for a similar solution for your
    for links in "next version" to work properly.

4. BREAKING: columnWrapperStyle should be rowWrapperStyle?

Mention scrollToIndex support. Fix a format error.
@facebook-github-bot facebook-github-bot added GH Review: review-needed CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. labels Mar 5, 2017
Copy link
Contributor

@ericvicenti ericvicenti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can accept the simple doc fixes ASAP, but the renaming of columnWrapperStyle is a breaking change and needs to be manually imported by a FB employee. Can you rename this PR to document the breaking change?

cc @sahrens, Based on the way it is used, it certainly seems that rowWrapperStyle is a better name. Do you agree, or should we fix up the doc to explain it better?

@sunnylqm sunnylqm changed the title Update FlatList doc BREAKING: Update FlatList doc Mar 6, 2017
@sunnylqm sunnylqm changed the title BREAKING: Update FlatList doc BREAKING: columnWrapperStyle -> rowWrapperStyle some other fypo fix Mar 6, 2017
@sunnylqm sunnylqm changed the title BREAKING: columnWrapperStyle -> rowWrapperStyle some other fypo fix BREAKING: columnWrapperStyle -> rowWrapperStyle and some other fypo fix Mar 6, 2017
@sunnylqm sunnylqm changed the title BREAKING: columnWrapperStyle -> rowWrapperStyle and some other fypo fix BREAKING: columnWrapperStyle -> rowWrapperStyle and some other typo fix Mar 6, 2017
@sunnylqm
Copy link
Contributor Author

ping @sahrens

Copy link
Contributor

@sahrens sahrens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea was that a "columnWrapper" makes a row that wraps the columns. It also makes it more obvious it's related to columns, "rowWrapper" sounds like something that would work even if numColumns=1

@sunnylqm
Copy link
Contributor Author

sunnylqm commented Mar 16, 2017

So....how about column"s"WrapperStyle ?

@sahrens
Copy link
Contributor

sahrens commented Mar 16, 2017

Hmm, if folks think columnsWrapperStyle is more clear, I could go for that.

@sahrens
Copy link
Contributor

sahrens commented Mar 16, 2017

Or maybe rowColumnsWrapperStyle?

@sunnylqm
Copy link
Contributor Author

sunnylqm commented Mar 17, 2017

Well, I am not a native speaker, so I think I should leave this weird naming problem to you guys.

@sunnylqm sunnylqm changed the title BREAKING: columnWrapperStyle -> rowWrapperStyle and some other typo fix Update FlatList doc Mar 17, 2017
@sahrens
Copy link
Contributor

sahrens commented Mar 17, 2017

@facebook-github-bot shipit

@facebook-github-bot facebook-github-bot added GH Review: accepted Import Started This pull request has been imported. This does not imply the PR has been approved. and removed GH Review: review-needed labels Mar 17, 2017
Copy link
Contributor

@sahrens sahrens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the doc fixes!

@facebook-github-bot
Copy link
Contributor

@sahrens has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@facebook-github-bot
Copy link
Contributor

I tried to merge this pull request into the Facebook internal repo but some checks failed. To unblock yourself please check the following: Does this pull request pass all open source tests on GitHub? If not please fix those. Does the code still apply cleanly on top of GitHub master? If not can please rebase. In all other cases this means some internal test failed, for example a part of a fb app won't work with this pull request. I've added the Import Failed label to this pull request so it is easy for someone at fb to find the pull request and check what failed. If you don't see anyone comment in a few days feel free to comment mentioning one of the core contributors to the project so they get a notification.

@facebook-github-bot facebook-github-bot added Import Failed and removed Import Started This pull request has been imported. This does not imply the PR has been approved. labels Mar 18, 2017
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.

None yet

4 participants