[TASK] Avoid using @covers annotations referencing methods
#820
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
oliverklee
added this to the
9.0.0: Drop support for PHP < 7.2 and clean up things milestone
oliverklee
changed the title
@covers annotations for methods@covers annotations referencing methods
According to the PHPUnit documentation [1], `@covers` annotations are only recommended to reference classes (and global functions), but not methods from classes. Also sort the `@covers` annotations. Note: This will probably artificially increase our calculated code coverage numbers until we migrate our tests to more focused unit tests. Closes #809 [1] https://docs.phpunit.de/en/8.5/annotations.html#covers
oliverklee
force-pushed
the
cleanup/covers
branch
from
355948a to
4553e3a
Compare
JakeQZ
reviewed
Jan 26, 2025
Collaborator
JakeQZ
left a comment
JakeQZ
left a comment
There was a problem hiding this comment.
I've added a query about an extra @covers. Otherwise looks fine.
This will probably artificially increase our calculated code coverage numbers
Maybe not artificially, as the tests are probably covering more than we previously stated they did.
| * @covers \Sabberworm\CSS\Value\LineName | ||
| * @covers \Sabberworm\CSS\Value\Size | ||
| * @covers \Sabberworm\CSS\Value\URL | ||
| * @covers \Sabberworm\CSS\Value\Value |
Collaborator
There was a problem hiding this comment.
Was it intentional to add that it covers Value\Value?
Collaborator
Author
There was a problem hiding this comment.
Yes, as missingPropertyValueStrict and missingPropertyValueLenient had been marked as covering \Sabberworm\CSS\Value\Value::parseValue().
JakeQZ
approved these changes
Jan 26, 2025
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.
According to the PHPUnit documentation [1],
@coversannotations are only recommended to reference classes (and global functions), but not methods from classes.Also sort the
@coversannotations.Note: This will probably artificially increase our calculated code coverage numbers until we migrate our tests to more focused unit tests.
Closes #809
[1] https://docs.phpunit.de/en/8.5/annotations.html#covers