Skip to content

SliverGridLayout API docs improvements#65394

Merged
shihaohong merged 1 commit intoflutter:masterfrom
pedromassango:sliver-grid-layout-api-docs
Sep 8, 2020
Merged

SliverGridLayout API docs improvements#65394
shihaohong merged 1 commit intoflutter:masterfrom
pedromassango:sliver-grid-layout-api-docs

Conversation

@pedromassango
Copy link
Member

Description

Improve the API docs for some of the public API of the SliverGridLayout class. Those changes were request on #16045.

Related Issues

Fixes #16045

Tests

Just API docs improvements, does not requires tests.

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.

@flutter-dashboard
Copy link

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 on the #hackers channel in Chat.

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

@flutter-dashboard flutter-dashboard bot added the framework flutter/packages/flutter repository. See also f: labels. label Sep 8, 2020
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

LGTM

@shihaohong shihaohong merged commit 38834d3 into flutter:master Sep 8, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 9, 2021
@pedromassango pedromassango deleted the sliver-grid-layout-api-docs branch January 22, 2022 10:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SliverGridLayout's documentation for get[Min|Max]ChildIndexForScrollOffset is misleading

4 participants