Skip to content

[image_picker] Adopt readme excerpts #3507

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.

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

Merged
merged 2 commits into from
Mar 27, 2023

Conversation

stuartmorgan-g
Copy link
Contributor

Converts the README from manually-maintained code snippets to using excerpts from a code file.

Includes sanity check tests of the snippet code to make sure it runs successfully.

Part of flutter/flutter#102679

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

Converts the README from manually-maintained code snippets to using excerpts
from a code file.

Includes sanity check tests of the snippet code to make sure it runs
successfully.

Part of flutter/flutter#102679
``` dart
import 'package:image_picker/image_picker.dart';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed this from the excerpt since I don't think there's much value in showing the standard import for using a package; we are mostly only doing this for unusual cases (like including platform implementation packages).

// Capture a photo.
final XFile? photo = await picker.pickImage(source: ImageSource.camera);
// Pick a video.
final XFile? galleryVideo =
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The variable names changed because there were variable redeclarations that didn't compile.

for (final XFile file in response.files) {
_handleFile(file);
}
final List<XFile>? files = response.files;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was added to avoid having to !; the code as written wasn't null-safe since it was doing a property lookup (which can't infer safety from earlier null checks).

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 27, 2023
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Mar 27, 2023
@auto-submit
Copy link
Contributor

auto-submit bot commented Mar 27, 2023

auto label is removed for flutter/packages, pr: 3507, due to - The status or check suite Mac_arm64 ios_platform_tests_shard_5 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 27, 2023
@auto-submit auto-submit bot merged commit 1ce89ad into flutter:main Mar 27, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 28, 2023
nploi pushed a commit to nploi/packages that referenced this pull request Jul 16, 2023
[image_picker] Adopt readme excerpts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: image_picker
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants