Update XCTestSuite comment to Swift #100
Conversation
This update also drops the parts of Apple's implementation that are currently unavailable.
|
Excellent, thanks for taking this on, @jonallured! I have a few comments that I'll leave inline... |
| @@ -10,28 +10,15 @@ | |||
| // XCTestSuite.swift | |||
| // A collection of test cases. | |||
| // | |||
| // A concrete subclass of XCTest, XCTestSuite is a collection of test cases. | |||
| // Suites are usually managed by the IDE, but XCTestSuite can also be | |||
There was a problem hiding this comment.
This is not true in the case of swift-corelibs-xctest. We build up a hierarchy of suites based on the test cases the user passes into XCTMain(). No IDE (Xcode, in the case of Apple XCTest) is involved.
|
Thanks for the feedback @modocache - I just pushed a commit that I think reads better. Any further thoughts? |
|
Excellent, thanks! 💯 |
The improved documentation from #100 used source comment syntax (`//`), not documentation syntax (`///`). It also combined the header comment with the documentation for XCTestSuite.
|
Ack, sorry @jonallured -- I noticed immediately after merging that you used source-level comments ( |
|
Hey @modocache, I noticed the two vs three slashes, but wasn't sure what their significance was - now I do! :D |
This update also drops the parts describing features of Apple's implementation that are currently unavailable. Those parts are:
testSuiteForTestCaseClass)defaultTestSuite)This PR is for https://bugs.swift.org/browse/SR-1145, hopefully I did this right! :D