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

Add description to suggested composer packages #985

Closed
wants to merge 1 commit into from

Conversation

AJenbo
Copy link
Contributor

@AJenbo AJenbo commented Mar 3, 2023

The value in suggestions is not for the version (like in required) but for a descriptive test that can help developers in deciding if they should install the suggested package.

This hint will be show to developers when running composer suggests

composer.json Outdated
@@ -47,8 +47,8 @@
"phpunit/phpunit": "^10.1"
},
"suggest": {
"ext-pcov": "*",
"ext-xdebug": "*"
"ext-pcov": "A fast code coverage driver",
Copy link
Owner

Choose a reason for hiding this comment

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

A better description would be "PHP extension that provides line coverage".

composer.json Outdated
"ext-pcov": "*",
"ext-xdebug": "*"
"ext-pcov": "A fast code coverage driver",
"ext-xdebug": "Code coverage driver"
Copy link
Owner

Choose a reason for hiding this comment

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

A better description would be "PHP extension that provides line coverage as well as branch and path coverage".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I updated both descriptions

The value in suggestions is not for the version (like in required) but
for a descriptive test that can help developers in deciding if they
should install the suggested package.

This hint will be show to developers when running `composer suggests`
@sebastianbergmann
Copy link
Owner

Cherry-picked into 9.2 and merged to main from there.

@AJenbo AJenbo deleted the patch-1 branch March 4, 2023 09:41
@AJenbo
Copy link
Contributor Author

AJenbo commented Mar 4, 2023

Thank you for the quick review :)

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.

None yet

2 participants