Make --include-extended-types default for Swift 5.9 #57
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
…xclude-extended-types flag
|
@swift-ci please test |
ethan-kusters
approved these changes
May 2, 2023
...tDocCPluginDocumentation/SwiftDocCPlugin.docc/Generating Documentation for Extended Types.md
Outdated
Show resolved
Hide resolved
|
|
||
| ```swift | ||
| public struct Sloth { } | ||
|
|
||
| extension Sloth { | ||
| // This function is included in the | ||
| // documentation by default. | ||
| // This function is always included |
There was a problem hiding this comment.
Nit: Technically this is a method and not a function: https://docs.swift.org/swift-book/documentation/the-swift-programming-language/methods/.
Functions in Swift are defined at the top-level.
Suggested change
| // This function is always included | |
| // This function is always included |
There was a problem hiding this comment.
Well, as it says in the first sentence: Methods are functions that are associated with a particular type. Not every function is a method, but every method is a function. But I'm happy to change it anyways :)
- mention default behavior earlier in docs - be more precise about method/function terminology in docs
|
@swift-ci please test |
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.
Bug/issue #, if applicable: swiftlang/swift-docc#210
Summary
This PR makes
--include-extended-typesthe default behavior for handling extended types when compiled with a Swift version greater or equal to 5.9. It also introduces the negative counterpart flag--exclude-extended-types, which is available from Swift 5.8. The default behavior for Swift 5.8 remains unchanged (equivalent to--exclude-extended-types).The DocC documentation for the Plugin has been reworded.
The relevant part of the help text generated by the plugin's help flag has been reworded and shown both flags (
--include-extended-typesand--exclude-extended-types) along with the default value. The text is the same for Swift 5.8 and Swift 5.9, except for the default value.Dependencies
None.
Testing
There are unit and integration tests making sure the behavior and help text is as expected for the Swift version the tests are run with. I ran the full
bin/testsuite with a Swift 5.7, Swift 5.8, and Swift 5.9 toolchain each and tested invocations manually with the same toolchains on a local test target.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded