Standardize usage of the term "test case" in the code and documentation #101
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
A test case consists of a single test method which is executed in the context of a test case subclass. Previously, "test case" was sometimes confusingly used to refer to the entire set of test methods on a test case subclass.
|
Good idea! The changes also look good to me. @mike-ferris-apple, could you ask @swift-ci to please test? Just spitballing, but maybe we could also one day add a "glossary" or something. It took me a while to understand what the following referred to:
|
|
@swift-ci please test |
|
Thanks, Daniel. I would definitely be in support of pushing for clarity in the Xcode docs as well, so definitely don't shy away from filing radars on that! |
|
One followup Radar posted: rdar://26002223 |
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.
While thinking about the terminology we've been using to talk about tests for this framework, I realized that the term "test case" is being used to mean two distinct things:
XCTestCaseinstance)XCTestCasesubclass, including all of its test methodsAfter thinking about it more carefully and looking through the Apple XCTest header comments*, I've come to the conclusion that #1 is the correct usage. This PR is an attempt to improve our consistency around this.
Looking for feedback on both the underlying assumptions and the specific changes I'm proposing here!
* Note: Assuming folks agree with this usage suggestion, I'll be opening a Radar also, as there are a couple of points where the same confusion can be detected in the Apple XCTest headers.