#50426 closed defect (bug) (fixed)
Remove @staticvar tags from core
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 5.5 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | good-first-bug has-patch has-dev-note |
Focuses: | docs | Cc: |
Description
In comment:7:ticket:49446, the usage of @staticvar
documentation tag came up.
It's currently used in core, but was not documented in the PHP Documentation Standards. It is now mentioned with a note that it has been used in the past, but should no longer be used.
Per discussion with @jrf, the tag was supported in phpDocumentor 1.x, but is no longer supported in 2.x and 3.x.
Usage of static variables is considered an internal implementation detail and has no information value for someone reading the docs. The tag is also not listed in WordPress Code Reference, so removing it would not remove anything from the user-facing documentation.
Attachments (2)
Change History (6)
#1
@
5 years ago
Hi,
I have a little mistake that the description is replaced by each other patches. And I didn't find to delete and re-upload the patch with the correct description.
Thank You,
#3
@
5 years ago
- Owner set to SergeyBiryukov
- Resolution set to fixed
- Status changed from new to closed
In 48109:
#4
@
5 years ago
- Keywords has-dev-note added
This received a call out in the Miscellaneous Developer Changes in 5.5 dev note: https://make.wordpress.org/core/2020/07/29/miscellaneous-developer-focused-changes-in-wordpress-5-5/.
Removed the @staticvar from wp-admin and all subfolders of wp-admin