Skip to content

Fix Drawer.child docstring to say ListView instead of SliverList - #180326

Merged
auto-submit[bot] merged 1 commit into
flutter:masterfrom
nathannewyen:fix-drawer-child-docs
Jan 7, 2026
Merged

auto-submit[bot] merged 1 commit into
flutter:masterfrom
nathannewyen:fix-drawer-child-docs

Conversation

@nathannewyen

Copy link
Copy Markdown
Contributor

Description

The docstring says "Typically a [SliverList]" but the class example uses ListView.

SliverList is used inside CustomScrollView, not as a direct child of Drawer.

Related Issue

Fixes #100268

@github-actions github-actions Bot added framework flutter/packages/flutter repository. See also f: labels. p: material_ui material_ui package in flutter/packages labels Dec 27, 2025

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the docstring for the Drawer.child property, correcting the typical child widget from SliverList to ListView. This change aligns the documentation with common usage patterns, the widget's own class-level documentation, and the provided example code. The fix is accurate and improves the clarity of the documentation for developers.

@dkwingsmt
dkwingsmt requested a review from Piinks January 7, 2026 19:02

@Piinks Piinks left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@MitchellGoodwin MitchellGoodwin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM as well!

@MitchellGoodwin MitchellGoodwin added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 7, 2026
@auto-submit auto-submit Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 7, 2026
@auto-submit

auto-submit Bot commented Jan 7, 2026

Copy link
Copy Markdown
Contributor

autosubmit label was removed for flutter/flutter/180326, because The base commit of the PR is older than 7 days and can not be merged. Please merge the latest changes from the main into this branch and resubmit the PR.

The example in the class uses ListView, not SliverList.
SliverList is used inside CustomScrollView, not as a direct child.

Fixes flutter#100268
@MitchellGoodwin MitchellGoodwin added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 7, 2026
@auto-submit
auto-submit Bot added this pull request to the merge queue Jan 7, 2026
Merged via the queue into flutter:master with commit 78f49c6 Jan 7, 2026
71 checks passed
@flutter-dashboard flutter-dashboard Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 7, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 8, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 8, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 8, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 8, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 9, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 9, 2026
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

framework flutter/packages/flutter repository. See also f: labels. p: material_ui material_ui package in flutter/packages

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Drawer.child has inconsistencies in docstring and api.flutter.dev

3 participants