PHPDoc: use union of literals for $method parameter throughout #1487
Conversation
This file contains 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
richardm-stripe
force-pushed
the
richardm-better-method-types
branch
from
5512ba2 to
38d8862
Compare
richardm-stripe
force-pushed
the
richardm-better-method-types
branch
from
38d8862 to
f85ffbd
Compare
|
Just rediscovered this has been hanging out for months. No reason not to merge it IMO. |
richardm-stripe
requested review from
a team and
pakrym-stripe
and removed request for
a team
pakrym-stripe
approved these changes
Jul 18, 2023
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.
Replaces
@param string $methodwith the more specific@param 'delete'|'get'|'post' $method.This is possibly a little stricter than necessary as CurlClient does
\strtolower, but I think it's best to standardize on lower case.This does mean that users using psalm/phpstan/etc. on a sufficiently strict setting will get new type errors when they upgrade, but that's in line with our policy that even "breaking" PHPDoc changes can happen in minor versions.