Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[SR-1145] XCTestSuite doc comments describe behavior exclusive to Apple XCTest #394

Closed
briancroom opened this issue Apr 4, 2016 · 2 comments
Closed

[SR-1145] XCTestSuite doc comments describe behavior exclusive to Apple XCTest #394

briancroom opened this issue Apr 4, 2016 · 2 comments
Labels
bug Documentation StarterBug XCTest

Comments

@briancroom
Copy link
Collaborator

Previous ID SR-1145
Radar None
Original Reporter @briancroom
Type Bug
Status Resolved
Resolution Done
Additional Detail from JIRA
Votes 0
Component/s XCTest
Labels Bug, Documentation, StarterBug
Assignee None
Priority Medium

md5: 0ed03ce823738ee5c09d488b11993363

Issue Description:

The current doc comments on `XCTestSuite` are copied verbatim from Apple XCTest headers. They talk about methods and behavior that isn't available (at least yet) on our XCTestSuite implementation. We should rewrite this documentation to be more applicable to the way that the class is used in swift-corelibs-xctest.

Especially in need of attention are the APIs merged in this PR, which added many new classes (XCTestRun etc.) with documentation that doesn't make sense in our context.

A little additional context from @modocache: #89 (comment)
@swift-ci
Copy link

Comment by Jon Allured (JIRA)

Submitted PR: #100

@briancroom
Copy link
Collaborator Author

I'm going to close this issue, as its core concern was addressed by jonallured (JIRA User) in his PR. There is certainly room for additional documentation improvements (always!), but that can be tracked elsewhere.

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 9, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Documentation StarterBug XCTest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@briancroom @swift-ci