[webview_flutter] Better documentation of Android Platform Views modes

[ludwiktrammer]

Fixes flutter/flutter#85215

Documentation improvement - documents the difference between the two modes more clearly, including the SDK requirement for the Virtual displays mode (which was previously missing, as described in flutter/flutter#85215)

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. (Note that unlike the flutter/flutter repo, the flutter/plugins repo does use dart format.)
• I signed the CLA.
• The title of the PR starts with the name of the plugin 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.
• I updated CHANGELOG.md to add a description of the change.
• I updated/added relevant documentation (doc comments with ///).
• I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test exempt.
• All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

[mvanbeusekom]

Thank you for this pull request. The text looks good, I just made some suggestions to fix some spelling mistakes.

[mvanbeusekom]

nit: remove redundant spaces to align code block the same way as the same block mentioned in the "Using Virtual displays" section.

Suggested change

	```groovy
	android {
	defaultConfig {
	minSdkVersion 19
	}
	}
	```
	```groovy
	android {
	defaultConfig {
	minSdkVersion 19
	}
	}

[ludwiktrammer]

Thanks, but they are not redundant - this is inside an enumerated list and the indentation is needed so that the code block remains a part of the correct list item.

[mvanbeusekom]

That makes sense, but then maybe also make sure the indentation is also used in the "Using Virtual displays" section?

[ludwiktrammer]

There is no list in the "Using Virtual displays" section (since it would be a one-element list)

[mvanbeusekom]

I don't understand, isn't it the exact same android/app/build.gradle file?

[mvanbeusekom]

I don't understand, isn't it the exact same android/app/build.gradle file?

Nevermind, I understand now. It is part of the list in the README.md, sorry for the confusion.

[mvanbeusekom]

Looks great, just one more thing. Could you add a line to the CHANGELOG.md describing the change using the "NEXT" version? Something like this:

NEXT:

* Improved the documentation on using the different Android Platform View modes.

[mvanbeusekom]

@ludwiktrammer sorry for being such a pain, but the you should rebase with master branch as you same to have a merge conflict on the CHANGELOG.md file now.

[ludwiktrammer]

@ludwiktrammer Sure. As to the changelog file: should I put literal "NEXT" or the next number ("2.0.12")?

[mvanbeusekom]

@ludwiktrammer Sure. As to the changelog file: should I put literal "NEXT" or the next number ("2.0.12")?

You can put the literal "NEXT" as it is not necessary to release a new version just for the documentation change. So we will include it with the next version. The "NEXT" literal is a reminder for the next change to include this in the release notes.

[ludwiktrammer]

@mvanbeusekom Ok, thanks. Then it's done :)

[mvanbeusekom]

LGTM, thank you very much for this contribution.

[stuartmorgan]

You can put the literal "NEXT" as it is not necessary to release a new version just for the documentation change.

For future reference, this is not our policy. See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#faq

Do I need to update the version if I'm just changing the README? Yes. Most people read the README on pub.dev, not GitHub, so a README change is not very useful until it's published.

In this case it's not a big deal since we expect to release webview_flutter again soon and can get it then, but README fixes shouldn't rely on that any more than code fixes.

[mvanbeusekom]

Apologies, my bad. Thank you for pointing that out @stuartmorgan.