Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

[image_picker] Lint for public DartDocs #2270

Merged
merged 1 commit into from
Nov 13, 2019
Merged

[image_picker] Lint for public DartDocs #2270

merged 1 commit into from
Nov 13, 2019

Conversation

mklim
Copy link
Contributor

@mklim mklim commented Nov 13, 2019

Description

Missing DartDocs were recently added to this plugin. Add a
package-specific analysis options to make sure that they don't regress
going forward.

Related Issues

flutter/flutter#44393

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (flutter analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. [shared_preferences]
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy.
  • I updated CHANGELOG.md to add a description of the change.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
  • No, this is not a breaking change.

Missing DartDocs were recently added to this plugin. Add a
package-specific analysis options to make sure that they don't regress
going forward.
@mklim mklim requested a review from cyanglaz November 13, 2019 00:09
Copy link
Contributor

@cyanglaz cyanglaz left a comment

Choose a reason for hiding this comment

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

LGTM modulo nits.

Comment on lines +11 to +14
/// Denotes that an image is being picked.
const String kTypeImage = 'image';

/// Denotes that a video is being picked.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Didn't read the code carefully but I think these can be private. I am not sure if we should hide it at this point as technically it would be a breaking change.

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'll just leave it public for now, there's not really a reason to risk hiding it after all this time.

@mklim mklim merged commit f5f0d57 into flutter:master Nov 13, 2019
@mklim mklim deleted the image_picker_analysis branch November 13, 2019 17:27
mormih pushed a commit to mormih/plugins that referenced this pull request Nov 17, 2019
Missing DartDocs were recently added to this plugin. Add a
package-specific analysis options to make sure that they don't regress
going forward.
hjc22 pushed a commit to hjc22/plugins that referenced this pull request Dec 13, 2019
* newCache/blackVideos: (105 commits)
  [connectivity] Fix reachability stream for iOS (flutter#2281)
  [google_sign_in] Port plugin to use the federated Platform Interface (flutter#2266)
  [webview_flutter] Add async NavigationDelegates (flutter#2257)
  Update cirrus to create IOS simulator on 13.2 an xCode 11 (flutter#2275)
  [battery] Update and migrate iOS example project (flutter#2089)
  [url_launcher] DartDoc and test improvements (flutter#2274)
  [google_maps_flutter] Define clang module for iOS, fix analyzer warnings (flutter#2182)
  [video_player] Add v2 embedding support (flutter#2226)
  [path_provider] Update and migrate iOS example project (flutter#2099)
  [sensors] Documentation and test improvements (flutter#2272)
  [image_picker] Lint for public DartDocs (flutter#2270)
  [connectivity] Lint for public DartDocs (flutter#2269)
  [shared_preferences] Update and migrate iOS example project (flutter#2103)
  [quick_actions] Update and migrate iOS example project (flutter#2100)
  [infra] Ignore analyzer issues in CI (flutter#2271)
  [android_intent] Add missing DartDocs (flutter#2268)
  Bump google_maps_flutter pubspec to match CHANGELOG (flutter#2267)
  [google_sign_in] Handle new style URLs in GoogleUserCircleAvatar (flutter#2252)
  [google_sign_in] Move plugin to its subdir to allow for federated implementations. Add platform interface. (flutter#2244)
  Make setMockInitialValues handle non-prefixed keys (flutter#2260)
  ...

# Conflicts:
#	packages/video_player/CHANGELOG.md
#	packages/video_player/android/src/main/java/io/flutter/plugins/videoplayer/VideoPlayerPlugin.java
#	packages/video_player/ios/video_player.podspec
#	packages/video_player/pubspec.yaml
#	packages/video_player/test/video_player_test.dart
sungmin-park pushed a commit to sungmin-park/flutter-plugins that referenced this pull request Dec 17, 2019
Missing DartDocs were recently added to this plugin. Add a
package-specific analysis options to make sure that they don't regress
going forward.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants