-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
[4.0] Correct @param docblock parameter types #29882
Conversation
I have tested this item ✅ successfully on c591762 This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882. |
I have tested this item ✅ successfully on 53d213a This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882. |
|
I have not tested this item. This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882. Had the wrong button. |
I have tested this item ✅ successfully on f04e476 This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882. |
1 similar comment
I have tested this item ✅ successfully on f04e476 This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882. |
RTC This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882. |
Thanks! |
Summary of Changes
Method signature changes in docblock only, no code changes
Actual result BEFORE applying this Pull Request
The docblock documented that
$id
could only be an integerThis is factually incorrect as evidenced by the second param
$byName
which is a bool that says if the$id
is the name (i.e. a string "site/administrator/api/cli etc") then to handle it differently than an integer client id.There are many places in code where $id is provided as a string of the name and
$byName
is set to true, further proving the documentation to be incorrect.Documentation Changes Required
None.