[XCTAssert] Document file and line params, as well as where assert functions may be used #24
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
| /// | ||
| /// - Parameter expression: A boolean test. If it evaluates to false, the | ||
| /// assertion fails and emits a test failure. | ||
| /// - Parameter message: An optional message to use in the failure if the |
There was a problem hiding this comment.
This change conflicts with #22--@briancroom and I both fix the assetion typo 😊
Whoever gets merged last will have to rebase their changes on master to resolve the conflicts. Just an FYI.
Although it is rare for people to specify these parameters manually, it is not so rare as to not require documentation. Add a note to the documentation that explains when they are useful. Also adopt documentation conventions from the Swift standard library: use `///` over `/** */`, and only have 80 characters per line.
The XCTAssert* family of functions require that XCTCurrentTestCase is set. Failures that occur outside of these conditions are never reported.
modocache
force-pushed
the
documentation
branch
from
f9b9089 to
474eddb
Compare
mike-ferris
pushed a commit
that referenced
this pull request
Jan 7, 2016
[XCTAssert] Document file and line params, as well as where assert functions may be used
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.
Although it is rare for people to specify these parameters manually, it is not so rare as to not require documentation; see https://twitter.com/mxcl/status/679719145567588353. Add a note to the documentation that explains when they are useful.
Also adopt documentation conventions from the Swift standard library: use
///over/** */, and only have 80 characters per line.In addition, the XCTAssert* family of functions require that XCTCurrentTestCase is set, so this pull request documents that as well.