#63795 closed defect (bug) (duplicate)
Suggestion: Standardizing PHPDoc Comments for Global Variables in Core Theme Files
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Milestone: | Priority: | normal | |
| Severity: | normal | Version: | |
| Component: | Bundled Theme | Keywords: | |
| Focuses: | docs | Cc: |
Description
Hello Team,
While reviewing the core theme files, I noticed that PHPDoc blocks are used for documenting some global variables, which is great. However, I also observed that several other global variables lack consistent PHPDoc documentation.
To improve code readability, support static analysis tools, and maintain clear documentation standards, it may be beneficial to standardize PHPDoc comments for all global variables throughout the Core codebase.
Just a suggestion that could contribute to better maintainability and developer experience.
Thank you!
Attachments (1)
Change History (6)
#1
@
5 months ago
Hi @viralsampat, Thanks for the ticket.
What exactly is to be tested in the doc changes?
#2
@
5 months ago
- Keywords 2nd-opinion has-patch dev-feedback needs-testing removed
- Milestone Awaiting Review deleted
- Resolution set to duplicate
- Status changed from new to closed
This is already part of #58715.
#3
@
5 months ago
Hello @sabernhardt,
I have reviewed the mentioned ticket and noticed that only three themes have been modified with added PHPDoc.
I have already covered the remaining themes, so we could consider updating the PR to include those changes as well. Let me know your thoughts.
Thanks
I have checked above mentioned issue and resolved it. Here, I have added my patch.