Fix incorrect tr_* function documentation. (#369)#375
Merged
eschaton merged 2 commits intoJul 2, 2026
Conversation
brarcher
reviewed
Jul 1, 2026
Contributor
|
Just had one comment to clarify some of the doc corrections, otherwise looks good. |
Contributor
|
Thanks for updating the docs! If you are able to submit your osx workflow fixes from #376, then this PR should be able to submit without me overriding the checks. If the osx tests end up being more involved though let me know and I can submit these doc updates. |
A few of the Doxygen comments on `tr_*` functions claims that they are only applicable when a TestResult represents a failure. This is incorrect; these functions will provide reasonable results for success as well, and should be documented as doing so.
Clarify that calling `srunner_create(NULL)` will return an empty suite runner to which suites can be added.
eschaton
force-pushed
the
eschaton/fix-incorrect-tr-docs
branch
from
322860a to
72b75c4
Compare
Collaborator
Author
|
I've just rebased so all the tests checks will be run again, now that I have the macOS ones all green. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
A few of the Doxygen comments on
tr_*functions claims that they are only applicable when a TestResult represents a failure. This is incorrect; these functions will provide reasonable results for success as well, and should be documented as doing so.