[#33723] - Fix UrlRule's phpDoc
- Fixed in Code Base
- 23 May 2021
- Medium
- Build: 4.0-dev
- # 33723
- Diff
- dryabov:patch-6
User tests: Successful: 2 Quy, richard67 Unsuccessful: 0
Fix Joomla\CMS\Form\Rule\UrlRule's phpDoc (JString is not part of Joomla!4, Joomla\String\StringHelper is used instead)
The code is not affected.
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Libraries |
I'm not sure. Maybe fully qualified name would reduce possible doubts, but this @see declaration is located quite close to use statements, so IMHO it should be clear.
I'm not sure. Maybe fully qualified name would reduce possible doubts, but this
@seedeclaration is located quite close tousestatements, so IMHO it should be clear.
@dryabov I'd prefer to have the full qualified name here. That's not a rule, just my (and a few others') preference. In existing code you would find examples for both, short and full qualified. But as these "@" comments are for docs and IDE tools I think it is better to have it full qualified because you don't necessarily see the "use" statement there.
| Labels |
Added:
?
|
||
Done
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/33723.
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/33723.
| Status | Pending | ⇒ | Ready to Commit |
RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/33723.
| Status | Ready to Commit | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2021-05-23 22:44:41 |
| Closed_By | ⇒ | richard67 | |
| Labels |
Added:
?
|
||
Thanks.
I have tested this item✅ successfully on 2748eb5
I have not been in this code backwater before so was interested to see there are two StringHelper classes. One in src\HTML\Helpers\StringHelper.php and another in vendor\joomla\string\src\StringHelper.php. Should that be mentioned in the see. Or is the use statement enough for the curious?
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/33723.