Skip to content
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

Merged
merged 2 commits into from
Nov 10, 2023

Conversation

clydegerber
Copy link
Contributor

@clydegerber clydegerber commented Nov 5, 2023

  • 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.
@@ -205,6 +205,13 @@
| `udat_toPatternRelativeDate` | |
| `udat_toPatternRelativeTime` | |
| `udat_unregisterOpener` | |
Warning: Implemented + Unimplemented != Total
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

Copy link
Contributor Author

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?

Copy link
Contributor Author

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.

@filmil
Copy link
Member

filmil commented Nov 6, 2023

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.

@clydegerber
Copy link
Contributor Author

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.
@clydegerber clydegerber changed the title Removing trailing '()' from function names in '/// Implements...' com… fix: Improve the accuracy of the coverage report. Nov 6, 2023
@filmil filmil assigned filmil and unassigned filmil Nov 10, 2023
@filmil filmil merged commit 684e1be into google:main Nov 10, 2023
15 checks passed
@clydegerber clydegerber deleted the fix_implements_comments branch December 4, 2023 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants