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

[image_picker_for_web] Add doc comments to point out that some arguments are'nt supported on the web #3551

Closed
wants to merge 0 commits into from

Conversation

devj3ns
Copy link
Contributor

@devj3ns devj3ns commented Feb 15, 2021

The arguments maxWidth, maxHeight and imageQuality of pickImage() and the argument maxDuration of pickVideo() are not supported in web version of the image_picker package.

I added some doc comments to point out that specifying these argument does not change anything on the pickedFile.

Pre-launch Checklist

  • The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. [shared_preferences]
  • 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 [Flutter Style Guide] and the [C++, Objective-C, Java style guides].
  • I listed at least one issue that this PR fixes in the description above.
  • I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test exempt.
  • 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 updated/added relevant documentation (doc comments with ///).
  • I signed the [CLA].
  • All existing and new tests are passing.

@ditman
Copy link
Member

ditman commented Feb 16, 2021

@devj3ns this is great! however because of how the code is imported, these code blocks might not be discoverable.

Do you mind adding a "Limitations of the web version" to the README of the package (similar to this, or this), so the information is right there in the front page of pub?

Thanks!!

@devj3ns
Copy link
Contributor Author

devj3ns commented Feb 18, 2021

Hey @ditman, I added the information to the README.md file :)

Copy link
Member

@ditman ditman left a comment

Choose a reason for hiding this comment

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

Fixed a little typo, let's go with this one!

@google-cla
Copy link

google-cla bot commented Feb 19, 2021

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

@ditman
Copy link
Member

ditman commented Feb 19, 2021

I broke this PR, fixing :)

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.

2 participants