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.

Sign up for GitHub

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

Jump to bottom

Documentation on SliverList.list(…) constructor has snippet not matching its description #134142

Closed
2 tasks done
kpsroka opened this issue Sep 6, 2023 · 2 comments · Fixed by #134483
Closed
2 tasks done

Documentation on SliverList.list(…) constructor has snippet not matching its description #134142

kpsroka opened this issue Sep 6, 2023 · 2 comments · Fixed by #134483
Assignees
@Piinks
Labels
d: api docs Issues with https://api.flutter.dev/ f: scrolling Viewports, list views, slivers, etc. found in release: 3.13 Found to occur in 3.13 found in release: 3.14 Found to occur in 3.14 framework flutter/packages/flutter repository. See also f: labels. P2 Important issues not at the top of the work list r: fixed Issue is closed as already fixed in a newer version team-framework Owned by Framework team triaged-framework Triaged by Framework team waiting for PR to land (fixed) A fix is in flight

Comments

@kpsroka
Copy link
Contributor

kpsroka commented Sep 6, 2023

Is there an existing issue for this?

Steps to reproduce

Look at the documentation comment on SliverList.list(…) constructor, which includes the following snippet:

  /// {@tool snippet}
  /// This example, which would be inserted into a [CustomScrollView.slivers]
  /// list, shows an infinite number of items in varying shades of blue:
  ///
  /// ```dart
  /// SliverList.list(
  ///   children: const <Widget>[
  ///     Text('Hello'),
  ///     Text('World!'),
  ///   ],
  /// );
  /// ```
  /// {@end-tool}

Expected results

Either the snippet description should be different, or (more useful) the snippet should match current description.

Actual results

Snippet's description and content don't match (the snipped does not show an infinite number of items in varying shades of blue, but rather two Text widgets).

Code sample

This is a documentation issue

No details to show, really

Screenshots or Video

No response

Logs

No response

Flutter Doctor output

flutter doctor -v 
[!] Flutter (Channel magic_mouse_3.10.3, 3.10.4-0.0.pre.2, on macOS 13.5.1 22G90 darwin-arm64, locale en-GB)
    • Flutter version 3.10.4-0.0.pre.2 on channel magic_mouse_3.10.3 at /Users/krzysztof/Workspace/superlist/.flutter
    ! Warning: `flutter` on your path resolves to /Users/krzysztof/flutter/bin/flutter, which is not inside your current Flutter SDK checkout at /Users/krzysztof/Workspace/superlist/.flutter. Consider adding /Users/krzysztof/Workspace/superlist/.flutter/bin to the front of your path.
    ! Warning: `dart` on your path resolves to /Users/krzysztof/flutter/bin/dart, which is not inside your current Flutter SDK checkout at /Users/krzysztof/Workspace/superlist/.flutter. Consider adding /Users/krzysztof/Workspace/superlist/.flutter/bin to the front of your path.
    ! Upstream repository https://github.com/superlistapp/flutter.git is not a standard remote.
      Set environment variable "FLUTTER_GIT_URL" to https://github.com/superlistapp/flutter.git to dismiss this error.
    • Framework revision 6be21d2d56 (6 months ago), 2023-03-06 14:53:46  0100
    • Engine revision 2a3401c9bb
    • Dart version 3.0.3
    • DevTools version 2.23.1
    • If those were intentional, you can disregard the above warnings; however it is recommended to use "git" directly to perform update checks and upgrades.

[✓] Android toolchain - develop for Android devices (Android SDK version 33.0.1)
    • Android SDK at /Users/krzysztof/Library/Android/sdk
    • Platform android-33, build-tools 33.0.1
    • Java binary at: /Applications/Android Studio.app/Contents/jre/Contents/Home/bin/java
    • Java version OpenJDK Runtime Environment (build 11.0.13 0-b1751.21-8125866)
    • All Android licenses accepted.

[✓] Xcode - develop for iOS and macOS (Xcode 14.2)
    • Xcode at /Applications/Xcode.app/Contents/Developer
    • Build 14C18
    • CocoaPods version 1.12.1

[✓] Chrome - develop for the web
    • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

[✓] Android Studio (version 2021.3)
    • Android Studio at /Applications/Android Studio.app/Contents
    • Flutter plugin can be installed from:
      🔨 https://plugins.jetbrains.com/plugin/9212-flutter
    • Dart plugin can be installed from:
      🔨 https://plugins.jetbrains.com/plugin/6351-dart
    • Java version OpenJDK Runtime Environment (build 11.0.13 0-b1751.21-8125866)

[✓] VS Code (version 1.81.1)
    • VS Code at /Applications/Visual Studio Code.app/Contents
    • Flutter extension version 3.72.0
@danagbemava-nc danagbemava-nc added the in triage Presently being triaged by the triage team label Sep 7, 2023
@danagbemava-nc
Copy link
Member

Thanks for pointing this out.

@danagbemava-nc danagbemava-nc added framework flutter/packages/flutter repository. See also f: labels. f: scrolling Viewports, list views, slivers, etc. d: api docs Issues with https://api.flutter.dev/ team-framework Owned by Framework team found in release: 3.13 Found to occur in 3.13 found in release: 3.14 Found to occur in 3.14 and removed in triage Presently being triaged by the triage team labels Sep 7, 2023
@Piinks Piinks added triaged-framework Triaged by Framework team P2 Important issues not at the top of the work list labels Sep 11, 2023
@Piinks Piinks self-assigned this Sep 12, 2023
@Piinks Piinks mentioned this issue Sep 12, 2023
Merged
8 tasks
@Piinks Piinks added the waiting for PR to land (fixed) A fix is in flight label Sep 12, 2023
auto-submit bot pushed a commit that referenced this issue Sep 12, 2023
@Piinks
Fix SliverList example descriptions (#134483)
fcba7b3 
Fixes #134142

The description for the SliverList.list example was just wrong, describing something other than the sample. � 
Tweaked some of the language on the others while I was here.
@danagbemava-nc danagbemava-nc added the r: fixed Issue is closed as already fixed in a newer version label Sep 13, 2023
@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 27, 2023
Mairramer pushed a commit to Mairramer/flutter that referenced this issue Oct 10, 2023
@Piinks @Mairramer
Fix SliverList example descriptions (flutter#134483)
5290d0c 
Fixes flutter#134142

The description for the SliverList.list example was just wrong, describing something other than the sample. � 
Tweaked some of the language on the others while I was here.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@Piinks Piinks

Labels
d: api docs Issues with https://api.flutter.dev/ f: scrolling Viewports, list views, slivers, etc. found in release: 3.13 Found to occur in 3.13 found in release: 3.14 Found to occur in 3.14 framework flutter/packages/flutter repository. See also f: labels. P2 Important issues not at the top of the work list r: fixed Issue is closed as already fixed in a newer version team-framework Owned by Framework team triaged-framework Triaged by Framework team waiting for PR to land (fixed) A fix is in flight
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix SliverList example descriptions Piinks/flutter
3 participants
@Piinks @kpsroka @danagbemava-nc