-
Notifications
You must be signed in to change notification settings - Fork 29
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.
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
fix: Improve the accuracy of the coverage report. #296
Conversation
clydegerber
commented
Nov 5, 2023
•
edited
Loading
edited
- Ignore trailing '()' characters in function names when reporting coverage.
- Only track functions that match a function in the header file of interest as implemented.
- Mark the uenum::uloc_open_keywords as deprecated, copy the implementation into the uloc crate and copy the test that was in the uloc crate into the uenum crate so that it is still protected by a test even though deprecated.
…ments when tracking coverage and implement some warning messages to highlight discrepancies in coverage tracking.
coverage/report.md
Outdated
@@ -205,6 +205,13 @@ | |||
| `udat_toPatternRelativeDate` | | | |||
| `udat_toPatternRelativeTime` | | | |||
| `udat_unregisterOpener` | | | |||
Warning: Implemented + Unimplemented != Total |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the question about the clarity of the message or the existence of the message? If it is about clarity, would something like "Warning: Count of total C API functions is not equal to the sum of the counts of implemented and non-implemented functions" be clearer?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An alternative would be to add a screen to the '*_implemented.txt' file creation to ignore functions that aren't in the C API for the given header file.
Is it possible to use the canonical git commit messages, with a short one-line summary, and a slightly longer synopsis? E.g. like https://www.conventionalcommits.org/en/v1.0.0/#summary - though I'm not a stickler to the specific format. |
Can do! |
- Ignore trailing '()' characters in function names when reporting coverage. - Only track functions that match a function in the header file of interest as implemented. - Mark the uenum::uloc_open_keywords as deprecated, copy the implementation into the uloc crate and copy the test that was in the uloc crate into the uenum crate so that it is still protected by a test even though deprecated.