Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Enhancement: Update command line help message for --platform #45

Merged
merged 1 commit into from
Oct 11, 2021

Conversation

weisunOW
Copy link
Contributor

@weisunOW weisunOW commented Jun 1, 2021

Description

Address #44

  • Update the command line help message to mention that maccatalyst platform is not included when --platform argument is omitted.

Detailed Design

N/A

Documentation Plan

How has the new feature been documented? Have the relevant portions of the guide been updated in addition to symbol-level documentation?

N/A

Test Plan

How is the new feature tested?

N/A

Source Impact

What is the impact of this change on existing users? Does it deprecate or remove any existing API?

This PR adds additional information to the help message of command option --platform to explain the actual behaviour when the option is omitted.

Actual behaviour:

Line 182 - Sources/CreateXCFramework/PackageInfo.swift

func supportedPlatforms () throws -> [TargetPlatform] {

        // if they have specified platforms all good, if not go everything except catalyst
        let supported = self.options.platform.nonEmpty ?? TargetPlatform.allCases.filter { $0 != .maccatalyst }
        
        // Omitted ...
}

Checklist

  • [ ] I've added at least one test that validates that my change is working, if appropriate
  • I've followed the code style of the rest of the project
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary

- include a mention that `maccatalyst` platform is not included if `--platform` argument is omitted.
@weisunOW weisunOW changed the title enhancement: Update argument help for --platform Enhancement: Update argument help for --platform Aug 4, 2021
@weisunOW weisunOW changed the title Enhancement: Update argument help for --platform Enhancement: Update command line help message for --platform Aug 4, 2021
@bok- bok- added patch A tiny change that only warrants a patch release documentation Improvements or additions to documentation labels Oct 11, 2021
@bok- bok- linked an issue Oct 11, 2021 that may be closed by this pull request
@bok- bok- merged commit 3a9aff5 into unsignedapps:main Oct 11, 2021
@weisunOW
Copy link
Contributor Author

Thanks @bok-

@weisunOW weisunOW deleted the patch-1 branch October 11, 2021 22:16
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation patch A tiny change that only warrants a patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update help menu entry for --platform.
2 participants