Repository navigation
AUTHORING: the example rule, its watch deviations and its one exception - #25
Merged
Merged
Conversation
AUTHORING §3 said to ship upstream's example verbatim. Spec 0006 Decision 1d already allowed three listed watch deviations and supplementary watchos_<topic>_test.dart tests, but the docs never said so. They do now, in AUTHORING, the README and the ci.yml header. New: when upstream's example cannot launch on the watch even with those deviations, the package ships a small watch demo of the app-facing API, and its PORTING_REPORT.md says why in an "## Example" section. The official integration_test still ships. A limit that only part of the example hits is not a reason.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AUTHORING.md§3 said to ship upstream's example verbatim, and nothing more. This PR writes the whole example rule down.Already decided, never written down. Two rules were settled before the launch but never reached the docs:
PORTING_REPORT.md:Platform.isIOSbecomesFlutterWatchosPlatform.isIoswhere the call it guards reaches a plugin with no watchOS implementation;*_watchospackage is added to the example's pubspec;watchos_<topic>_test.dart, never in their place.New exception. When upstream's example cannot launch on the watch even with those deviations, the package ships a small watch demo of the app-facing API instead. Its
PORTING_REPORT.mdsays why, in an## Examplesection, and the officialintegration_teststill ships. A limit that only part of the example hits, such as a link the watch cannot open, is not a reason. The first case is #9: upstream'smain()awaits flutter_timezone, which has no watchOS implementation.The README's "Examples & tests" section and the
ci.ymlheader now say the same thing. #24 brings our own written-by-us examples in line with the rule.Docs and a workflow comment only. The word check and the README snippet check pass.