[native_assets_cli] Improve documentation for DynamicLoadingBundled
#1058
Conversation
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
Package publishing
Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation. |
PR HealthBreaking changes ✔️Details
Changelog Entry ✔️Details
Changes to files need to be accounted for in their respective changelogs. Coverage ✔️Details
This check for test coverage is informational (issues shown here will not fail the PR). License Headers ✔️Details
All source files should start with a license header. Unrelated files missing license headers
Package publish validation ✔️Details
Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation. |
mosuem
approved these changes
Mar 26, 2024
| @@ -64,8 +64,9 @@ abstract final class NativeCodeAsset implements Asset { | |||
| /// How this file is bundled depends on the kind of asset, represented by a | |||
| /// concrete subtype of [Asset], and the SDK (Dart or Flutter). | |||
| /// | |||
| /// If the [linkMode] is [DynamicLoadingBundled], the file most be provided in | |||
| /// the [BuildOutput] for [BuildConfig.dryRun]. | |||
| /// If the [linkMode] is [DynamicLoadingBundled], the file must be provided in | |||
There was a problem hiding this comment.
This paragraph is a bit confusing - you must provide a file for a dry run, but actually a file name is enough?
There was a problem hiding this comment.
Yeah. As the full path doesn't really make sense in dry run, the full path is going to be different for the 2 or 3 wet runs (for the different architectures) that follow later in the flutter build.
Suggestions on how to clarify this?
There was a problem hiding this comment.
But I thought dry runs actually do expect a real file, so the path must also be real? Why would it change?
There was a problem hiding this comment.
No, dry runs only need to provide the name, not the file.
There was a problem hiding this comment.
Then I would insert a not, or what am I missing?
/// If the [linkMode] is [DynamicLoadingBundled], the file must not be provided
/// in the [BuildOutput] for [BuildConfig.dryRun]. Supplying a file name instead
/// of an absolute path is enough for [BuildConfig.dryRun].
There was a problem hiding this comment.
Or is this a confusion between the file existing, and the Dart File object existing?
There was a problem hiding this comment.
Indeed, the file on disk does not have to exist in dry run, but the Url file must be provided. 🙈
mosuem
approved these changes
Mar 26, 2024
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.
Closes: #1049