Include Test.{Result, Pass, Fail, Error, Broken} in documentation #31854
Conversation
This file contains 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
tkf
commented
Apr 27, 2019
|
|
||
| All tests produce a result object. This object may or may not be | ||
| stored, depending on whether the test is part of a test set. | ||
| """ | ||
| abstract type Result end | ||
|
|
||
| """ | ||
| Pass | ||
| Test.Pass <: Test.Result |
There was a problem hiding this comment.
I added the prefix Test. here and to the other types to signify that those types are not exported. I think <: Test.Result also clarifies what they are.
simonbyrne
added
domain:docs
vtjnash
added
the
status:merge me
vtjnash
force-pushed
the
docs-test-result
branch
from
830a2c8
to
4a7271a
Compare
DilumAluthge
removed
the
status:merge me
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.
The docstrings of the public API are already referring to
Test.Resultand its subtypes. Also, querying test results seems to be a popular demand [1]. So, I think it makes sense to signal that they are public API by including them in the documentation.[1] For example, it would be nice if the exception thrown in
@test_throwscan be accessed. It can be done byHowever, since
Passand its fields are not documented, I cannot use this API (see also https://discourse.julialang.org/t/19224). Another example is to provide debug info upon test failure #31495.