Skip to content

[BUGFIX] Fix return type annotation of Value::isSize() #892

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Feb 9, 2025
Merged

[BUGFIX] Fix return type annotation of Value::isSize() #892

merged 2 commits into from
Feb 9, 2025

Conversation

oliverklee
Copy link
Collaborator

No description provided.

@oliverklee oliverklee self-assigned this Feb 9, 2025
@coveralls
Copy link

coveralls commented Feb 9, 2025 •
edited
Loading

Coverage Status

coverage: 49.156%. remained the same
when pulling 2f7e23e on cleanup/type-annotation
into 6e43258 on main.

JakeQZ
JakeQZ requested changes Feb 9, 2025
View reviewed changes
Copy link
Collaborator

@JakeQZ JakeQZ left a comment

Choose a reason for hiding this comment

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

I think the comment can just be changed to use the word "Returns" instead of @return.

src/Value/Size.php
@@ -186,7 +186,7 @@ public function isColorComponent()
/**
* Returns whether the number stored in this Size really represents a size (as in a length of something on screen).
*
* @return false if the unit an angle, a duration, a frequency or the number is a component in a Color object.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think just change this comment to not involve a type annotation - i.e. "Returns false if the unit [is]..." (and add the missing "is") - so the meaning is retained.

CHANGELOG.md Outdated
@@ -45,6 +45,7 @@ Please also have a look at our

### Fixed

- Fix return type annotation of `Value::isSize()` (#892)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not sure if we're just changing a DocBlock comment this warrants a changelog entry.

@oliverklee oliverklee requested a review from JakeQZ February 9, 2025 17:45
@JakeQZ JakeQZ merged commit 5e05197 into main Feb 9, 2025
21 checks passed
@JakeQZ JakeQZ deleted the cleanup/type-annotation branch February 9, 2025 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JakeQZ JakeQZ JakeQZ approved these changes

@sabberworm sabberworm Awaiting requested review from sabberworm

Assignees

@oliverklee oliverklee

Labels
bug cleanup
Projects
None yet
Milestone
9.0.0: Drop support for PHP < 7.2 and...
Development

Successfully merging this pull request may close these issues.
3 participants
@oliverklee @coveralls @JakeQZ