Replace the default value of the first parameter of getErrorList() and getWarningList() with an empty string #168
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
This commit removes the first paramter from getErrorList() and getWarningList() when the parameter is not used inside the method.
Replacing the default value with an empty string. Per Juliette's comment (PHPCSStandards#163 (comment)) there are three reasons why we want to do that: - The default value has no value in practice. It is an optional argument which is not enforced via the abstract functions, but is passed in all cases, so the default is never used in practice. - Setting the default value as file 1 also has an assumption implied, while IMO assumptions have no place in a test suite. - Maintainability - one less thing to have to keep in sync and to guard against typos
Replacing the default value with an empty string. Per Juliette's comment (PHPCSStandards#163 (comment)) there are three reasons why we want to do that: - The default value has no value in practice. It is an optional argument which is not enforced via the abstract functions, but is passed in all cases, so the default is never used in practice. - Setting the default value as file 1 also has an assumption implied, while IMO assumptions have no place in a test suite. - Maintainability - one less thing to have to keep in sync and to guard against typos
11 tasks
rodrigoprimo
force-pushed
the
get-error-list-remove-default-value
branch
from
93ae40e to
e3d3100
Compare
jrfnl
approved these changes
Dec 15, 2023
There was a problem hiding this comment.
Thanks for picking up this task @rodrigoprimo ! All looks good to me.
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.
Description
Per @jrfnl's suggestion here, this PR replaces the default value of the first parameter of getErrorList() and getWarningList() with an empty string. The default value is never used, as the first parameter is always passed when those two methods are called.
While working on this, I noticed some cases where the first parameter was not used inside getErrorList() or getWarningList(). For those, instead of replacing the default value with an empty string, I removed the parameter from the method signature.
Suggested changelog entry
Replace the default value of the first parameter of getErrorList() and getWarningList() with an empty string
Related issues/external references
Discussed in #163 (comment)
Types of changes
PR checklist