From 356fa4f853629441b3898b2c42c557cc9d451214 Mon Sep 17 00:00:00 2001 From: Mike Date: Mon, 27 Nov 2023 20:22:49 -0800 Subject: [PATCH 1/2] [flutter_image] Adopt code excerpts in README --- packages/flutter_image/CHANGELOG.md | 3 ++- packages/flutter_image/README.md | 5 +++-- .../example/lib/readme_excerpts.dart | 17 ++++++++++++++ .../example/test/readme_excerpts_test.dart | 22 +++++++++++++++++++ packages/flutter_image/pubspec.yaml | 2 +- script/configs/temp_exclude_excerpt.yaml | 1 - 6 files changed, 45 insertions(+), 5 deletions(-) create mode 100644 packages/flutter_image/example/lib/readme_excerpts.dart create mode 100644 packages/flutter_image/example/test/readme_excerpts_test.dart diff --git a/packages/flutter_image/CHANGELOG.md b/packages/flutter_image/CHANGELOG.md index d3a8cbc41ce7..6067591c5586 100644 --- a/packages/flutter_image/CHANGELOG.md +++ b/packages/flutter_image/CHANGELOG.md @@ -1,6 +1,7 @@ -## NEXT +## 4.1.10 * Updates minimum supported SDK version to Flutter 3.10/Dart 3.0. +* Updates README to improve example of using `NetworkImageWithRetry`. ## 4.1.9 diff --git a/packages/flutter_image/README.md b/packages/flutter_image/README.md index f31adcd98f76..11529c146883 100644 --- a/packages/flutter_image/README.md +++ b/packages/flutter_image/README.md @@ -7,9 +7,10 @@ network with a retry mechanism. Example: + ```dart -var avatar = new Image( - image: new NetworkImageWithRetry('http://example.com/avatars/123.jpg'), +const Image avatar = Image( + image: NetworkImageWithRetry('http://example.com/avatars/123.jpg'), ); ``` diff --git a/packages/flutter_image/example/lib/readme_excerpts.dart b/packages/flutter_image/example/lib/readme_excerpts.dart new file mode 100644 index 000000000000..226fe91fdd2a --- /dev/null +++ b/packages/flutter_image/example/lib/readme_excerpts.dart @@ -0,0 +1,17 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import 'package:flutter/widgets.dart'; +import 'package:flutter_image/flutter_image.dart'; + +/// Demonstrates loading an image for the README. +Image networkImageWithRetry() { +// #docregion NetworkImageWithRetry + const Image avatar = Image( + image: NetworkImageWithRetry('http://example.com/avatars/123.jpg'), + ); +// #enddocregion NetworkImageWithRetry + + return avatar; +} diff --git a/packages/flutter_image/example/test/readme_excerpts_test.dart b/packages/flutter_image/example/test/readme_excerpts_test.dart new file mode 100644 index 000000000000..32e315205a36 --- /dev/null +++ b/packages/flutter_image/example/test/readme_excerpts_test.dart @@ -0,0 +1,22 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import 'package:flutter/widgets.dart'; +import 'package:flutter_image/flutter_image.dart'; +import 'package:flutter_image_example/readme_excerpts.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() { + test('networkImageWithRetry returns an Image with NetworkImageWithRetry', () { + // Ensure that the snippet code runs successfully. + final Image result = networkImageWithRetry(); + + // It should have a image property of the right type + expect(result.image, isInstanceOf()); + // And the NetworkImageWithRetry should have a url property + final NetworkImageWithRetry networkImage = + result.image as NetworkImageWithRetry; + expect(networkImage.url, equals('http://example.com/avatars/123.jpg')); + }); +} diff --git a/packages/flutter_image/pubspec.yaml b/packages/flutter_image/pubspec.yaml index 538d4a416838..483576343d1d 100644 --- a/packages/flutter_image/pubspec.yaml +++ b/packages/flutter_image/pubspec.yaml @@ -3,7 +3,7 @@ description: > Image utilities for Flutter: improved network providers, effects, etc. repository: https://github.com/flutter/packages/tree/main/packages/flutter_image issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+flutter_image%22 -version: 4.1.9 +version: 4.1.10 environment: sdk: ">=3.0.0 <4.0.0" diff --git a/script/configs/temp_exclude_excerpt.yaml b/script/configs/temp_exclude_excerpt.yaml index c1fe3e9aa864..8fd0a51f1366 100644 --- a/script/configs/temp_exclude_excerpt.yaml +++ b/script/configs/temp_exclude_excerpt.yaml @@ -8,7 +8,6 @@ - css_colors - espresso - extension_google_sign_in_as_googleapis_auth -- flutter_image - go_router_builder - google_sign_in/google_sign_in - image_picker_for_web From 50026bc44e0913ebd1213aa17f7990f8dbf33308 Mon Sep 17 00:00:00 2001 From: Mike Date: Wed, 29 Nov 2023 13:55:18 -0800 Subject: [PATCH 2/2] fix comments to have periods --- packages/flutter_image/example/test/readme_excerpts_test.dart | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/flutter_image/example/test/readme_excerpts_test.dart b/packages/flutter_image/example/test/readme_excerpts_test.dart index 32e315205a36..92365379e393 100644 --- a/packages/flutter_image/example/test/readme_excerpts_test.dart +++ b/packages/flutter_image/example/test/readme_excerpts_test.dart @@ -12,9 +12,9 @@ void main() { // Ensure that the snippet code runs successfully. final Image result = networkImageWithRetry(); - // It should have a image property of the right type + // It should have a image property of the right type. expect(result.image, isInstanceOf()); - // And the NetworkImageWithRetry should have a url property + // And the NetworkImageWithRetry should have a url property. final NetworkImageWithRetry networkImage = result.image as NetworkImageWithRetry; expect(networkImage.url, equals('http://example.com/avatars/123.jpg'));