Clarify types on hook_custom and hook_customPre
#20488
Merged
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
The custom & customPre hooks are not called elsewhere in gituniverse so we can add type hints and fix casting & comments to make it clearer what the variables are
|
(Standard links)
|
eileenmcnaughton
commented
Jun 3, 2021
| @@ -48,8 +48,7 @@ public static function create($customParams, $parentOperation = NULL) { | |||
| $count = 1; | |||
|
|
|||
| $firstField = reset($fields); | |||
| $entityID = $firstField['entity_id']; | |||
There was a problem hiding this comment.
The brevity of casting to a var vs the loss of clarify is a little greater for entity_id as entityID is less vague & it's used more
hook_custom and hook_customPre
|
Looks reasonable to me... I can't imagine a good reason why those parameters would have other types. |
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.
Overview
Clarify types on custom hooks
The custom & customPre hooks are not called elsewhere in gituniverse
so we can add type hints and fix casting & comments to make it
clearer what the variables are
Before
Types unclear & some incorrectly documented
After
Casting, hints, correct docs
Technical Details
Comments