[#29882] - [4.0] Correct @param docblock parameter types
- Fixed in Code Base
- 11 Jul 2020
- Medium
- Build: 4.0-dev
- # 29882
- Diff
- PhilETaylor:getinfodocblock
- Pending Hound Hound is busy sniffing around... Details
User tests: Successful: Unsuccessful:
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 integer
This 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.
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Libraries |
| Labels |
Added:
?
|
||
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882.
Whereas normal code indenting uses real tabs, all whitespace in a Docblock uses real spaces. This provides better readability in source code browsers. The minimum whitespace between any text elements, such as tags, variable types, variable names and tag descriptions, is two real spaces.
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
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882.
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882.
| Status | Pending | ⇒ | Ready to Commit |
RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/29882.
| Status | Ready to Commit | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2020-07-11 15:45:26 |
| Closed_By | ⇒ | richard67 | |
| Labels |
Added:
?
|
||
Thanks!
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.