mirror of
https://github.com/flutter/flutter.git
synced 2026-02-20 02:29:02 +08:00
docs: fix ListView reference in SliverList documentation (#165827)
**Description** This pull request fixes a minor documentation issue in the SliverList reference, where a missing closing bracket ] in the ListView reference could lead to confusion when reading the docs. By correcting this, we improve the readability and clarity of the documentation for Flutter developers referencing the SliverList widget. **Why is this change needed?** - Proper documentation is essential for developers to understand Flutter widgets efficiently. - The missing bracket could cause confusion for new contributors and developers reading the API documentation. - While this is a small fix, ensuring high-quality documentation aligns with Flutter’s commitment to a great developer experience. **Screenshot Before Fixing** <img width="615" alt="Screenshot 2025-03-25 at 12 08 15 AM" src="https://github.com/user-attachments/assets/d714d15d-5c78-46cf-8e7e-7347a788f9c7" /> **Screenshot After Fixing** <img width="578" alt="Screenshot 2025-03-25 at 12 20 20 AM" src="https://github.com/user-attachments/assets/59dce920-1901-4d89-a598-f9e79a07a2d2" /> **Joining the Flutter Open-Source Community** This is my first open-source contribution to Flutter, and I’m very excited to start contributing more to the project! 🚀 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with ///). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing.
This commit is contained in:
parent
4d24ba4df2
commit
9ad5fc233b
@ -787,7 +787,7 @@ class CustomScrollView extends ScrollView {
|
||||
/// be laid out in a viewport (i.e. when scrolling).
|
||||
///
|
||||
/// Typically, the simplest way to combine boxes into a sliver environment is
|
||||
/// to use a [SliverList] (maybe using a [ListView, which is a convenient
|
||||
/// to use a [SliverList] (maybe using a [ListView], which is a convenient
|
||||
/// combination of a [CustomScrollView] and a [SliverList]). In rare cases,
|
||||
/// e.g. if a single [Divider] widget is needed between two [SliverGrid]s,
|
||||
/// a [SliverToBoxAdapter] can be used to wrap the box widgets.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user