Update Swift Package Manager docs to reflect on-by-default behavior#13468
Update Swift Package Manager docs to reflect on-by-default behavior#13468nexivionlabs wants to merge 2 commits into
Conversation
As of Flutter 3.44 stable, Swift Package Manager is on by default. Update the two SPM pages and the shared enable/disable partial so they no longer state SPM is off by default. CocoaPods remains documented as a fallback and the opt-out section is unchanged. Fixes flutter#13447
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to reflect that Swift Package Manager support is enabled by default starting with Flutter 3.44, and that CocoaPods is now supported as a fallback. The review feedback suggests improving the professionalism and consistency of the terminology used throughout the documentation by replacing informal phrasing like 'on by default' and 'turned off' with standard terms such as 'enabled by default' and 'disabled', along with updating the corresponding link references.
| As of Flutter 3.44, Flutter's Swift Package Manager support is turned on by | ||
| default. You don't need to do anything to enable it. |
There was a problem hiding this comment.
Using 'enabled by default' and avoiding repetitive phrasing ('enabled' ... 'enable') improves the professionalism and readability of the documentation. Consider rephrasing to use 'enabled by default' and 'No additional steps are required to use it'.
| As of Flutter 3.44, Flutter's Swift Package Manager support is turned on by | |
| default. You don't need to do anything to enable it. | |
| As of Flutter 3.44, Flutter's Swift Package Manager support is enabled by | |
| default. No additional steps are required to use it. |
| If you're using an older Flutter version, or you previously turned Swift Package | ||
| Manager support off, turn it on: |
There was a problem hiding this comment.
Using 'disabled' and 'enable it' is more professional and consistent with standard technical documentation terminology than 'turned ... off' and 'turn it on'.
| If you're using an older Flutter version, or you previously turned Swift Package | |
| Manager support off, turn it on: | |
| If you're using an older Flutter version, or you previously disabled Swift Package | |
| Manager support, you can enable it: |
| Flutter is migrating to [Swift Package Manager][] to manage iOS and macOS native | ||
| dependencies. | ||
| Flutter's support of Swift Package Manager is under development. | ||
| As of Flutter 3.44, Swift Package Manager support is [on by default][]. |
There was a problem hiding this comment.
Using 'enabled by default' is more standard and professional in technical documentation than 'on by default'.
| As of Flutter 3.44, Swift Package Manager support is [on by default][]. | |
| As of Flutter 3.44, Swift Package Manager support is [enabled by default][]. |
|
|
||
| [Swift Package Manager]: https://www.swift.org/documentation/package-manager/ | ||
| [off by default]: #how-to-turn-on-swift-package-manager | ||
| [on by default]: #how-to-turn-on-swift-package-manager |
There was a problem hiding this comment.
Update the link reference to match the updated 'enabled by default' terminology.
| [on by default]: #how-to-turn-on-swift-package-manager | |
| [enabled by default]: #how-to-turn-on-swift-package-manager |
| Flutter is migrating to [Swift Package Manager][] | ||
| to manage iOS and macOS native dependencies. | ||
| Flutter's support of Swift Package Manager is under development. | ||
| As of Flutter 3.44, Swift Package Manager support is [on by default][]. |
There was a problem hiding this comment.
Using 'enabled by default' is more standard and professional in technical documentation than 'on by default'.
| As of Flutter 3.44, Swift Package Manager support is [on by default][]. | |
| As of Flutter 3.44, Swift Package Manager support is [enabled by default][]. |
|
|
||
| [Swift Package Manager]: https://www.swift.org/documentation/package-manager/ | ||
| [off by default]: #how-to-turn-on-swift-package-manager | ||
| [on by default]: #how-to-turn-on-swift-package-manager |
There was a problem hiding this comment.
Update the link reference to match the updated 'enabled by default' terminology.
| [on by default]: #how-to-turn-on-swift-package-manager | |
| [enabled by default]: #how-to-turn-on-swift-package-manager |
Apply the review suggestions: use "enabled by default" / "disabled" / "enable it" instead of "on by default" / "turned off" / "turn it on", and update the reference-link labels accordingly.
|
Thanks for the review! Applied all the suggestions — switched to "enabled by default" / "disabled" / "enable it" and updated the reference-link labels accordingly. |
1 participant
Summary
Fixes #13447. The Swift Package Manager docs stated SPM support is "off by default", but as of Flutter 3.44 stable it is on by default. This updates the two SPM pages and the shared enable/disable partial to reflect the new default.
Changes
for-app-developers.md/for-plugin-authors.md: reword the warning box (on by default as of 3.44; CocoaPods remains a fallback) and rename the[off by default]reference label to[on by default](anchor unchanged)._includes/docs/swift-package-manager/how-to-enable-disable.md: reframe "How to turn on" to note SPM is on by default as of 3.44 and scope the manual enable steps to older versions or previously-disabled cases. The "How to turn off" opt-out section is unchanged.Notes
The
#how-to-turn-on-swift-package-managerheading is preserved (it is referenced by several migration partials), so there is no link churn. The plugin-author testing workflow is left intact.