Skip to content

Update RefreshIndicator documentation to clarify the need for the child to be scrollable#50345

Merged
fluttergithubbot merged 1 commit intoflutter:masterfrom
perclasson:update_refresh_indicator_documentation
Feb 10, 2020
Merged

Update RefreshIndicator documentation to clarify the need for the child to be scrollable#50345
fluttergithubbot merged 1 commit intoflutter:masterfrom
perclasson:update_refresh_indicator_documentation

Conversation

@perclasson
Copy link
Copy Markdown
Contributor

@perclasson perclasson commented Feb 7, 2020

Description

Update RefreshIndicator documentation to clarify the need for the child to be scrollable. Screenshot from documentation:

Screenshot 2020-02-10 at 10 47 50

Related Issues

Closes #22180

Tests

N/A, just updating documentation

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I signed the CLA.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I updated/added relevant documentation (doc comments with ///).
  • All existing and new tests are passing.
  • The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

  • No, no existing tests failed, so this is not a breaking change.
  • Yes, this is a breaking change. If not, delete the remainder of this section.
    • I wrote a design doc: https://flutter.dev/go/template Replace this with a link to your design doc's short link
    • I got input from the developer relations team, specifically from: Replace with the names of who gave advice
    • I wrote a migration guide: Replace with a link to your migration guide

@fluttergithubbot fluttergithubbot added f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. labels Feb 7, 2020
@fluttergithubbot
Copy link
Copy Markdown
Contributor

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Copy link
Copy Markdown
Contributor

@rami-a rami-a left a comment

Choose a reason for hiding this comment

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

LGTM

@perclasson perclasson requested a review from HansMuller February 7, 2020 16:48
Copy link
Copy Markdown
Contributor

@HansMuller HansMuller left a comment

Choose a reason for hiding this comment

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

LGTM with some suggestions about the doc.

Comment thread packages/flutter/lib/src/material/refresh_indicator.dart Outdated
Comment thread packages/flutter/lib/src/material/refresh_indicator.dart Outdated
@perclasson perclasson force-pushed the update_refresh_indicator_documentation branch from 3a9c95c to 4f41ccb Compare February 10, 2020 09:41
@fluttergithubbot fluttergithubbot merged commit 5f46589 into flutter:master Feb 10, 2020
@perclasson perclasson deleted the update_refresh_indicator_documentation branch February 14, 2020 11:23
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Aug 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

RefreshIndicator breaks when the ListView has a ScrollController

5 participants