#57069 closed task (blessed) (fixed)
Document the globals in various docblocks.
Reported by: | upadalavipul | Owned by: | audrasjb |
---|---|---|---|
Milestone: | 6.2 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
function commenting details needs to improve.
File Names:
wp-includes/class-wp-block.php
wp-includes/class-wp-tax-query.php
wp-includes/class-wp-term-query.php
wp-includes/class-wp-locale.php
Function Name: render(), transform_query(), parse_orderby() and init()
Attachments (19)
Change History (44)
#1
@
2 years ago
- Keywords has-patch commit added
- Milestone changed from Awaiting Review to 6.2
- Version trunk deleted
#3
@
2 years ago
- Summary changed from Document the globals in the below description files functions. to Document the globals in various docblocks.
- Type changed from defect (bug) to task (blessed)
Hello and thanks for the ticket!
We had the exact same ticket yesterday with #57058, this time let's use this ticket to address more occurrences of the same issue :)
Feel free to add more patches to this ticket if you find more missing or erroneous globals.
Thanks!
#4
@
2 years ago
Hi @upadalavipul
I've found one more file you could update on patch.
- /wp-admin/includes/class-wp-upgrader.php - L910
#5
@
2 years ago
- Keywords commit removed
[54867] merges the code proposed in 57069.patch
, 57069.2.patch
and 57069.4.patch
.
#8
@
2 years ago
I'll commit 57069.5.patch
.
I'm unsure about 57069.6.patch
as those are deprecated functions.
#14
@
2 years ago
@viralsampat it looks like 57069.diff
adds some unrelated changes:
// Check array attributes place holder value isset or not if( empty( $attributes['placeholder'] ) ) { $attributes['placeholder'] = 'Optional placeholder…'; }
(also, this change doesn't follow WPCS)
Edit: same goes for 57069.2.diff
, this patch is unrelated.
#15
@
2 years ago
HELLO @audrasjb
Thank you so much for sharing your feedback.
By mistake I had created patch with old changes.
Can I will create new patch and can I add it back?
Please let me know your feedback for the same.
Thanks,
#16
@
2 years ago
@upadalavipul I'm going to partially commit 57069.9.patch
. Worth noting that I made a few changes from your original patch:
twentytwenty/inc/template-tags.php
: I moved the first declaration to line 244.wp-includes/blocks/comments.php
: this needs to be addressed on Gutenberg side. Please open a PR on the GH repository.
#19
@
22 months ago
@viralsampat for 57069.3.diff and 57069.4.diff, it would be nice to add a small description for the globals.
@upadalavipul 57069.11.diff contains unrelated changes and we can't commit 57069.12.diff as these files are located in the Block Editor and should be modified on Gutenberg GitHub repository.
This ticket was mentioned in Slack in #core by costdev. View the logs.
21 months ago
This ticket was mentioned in Slack in #core by mukeshpanchal27. View the logs.
21 months ago
@
21 months ago
Globals reordered to meet the established docblock format + type added for $wp_customize
#22
@
21 months ago
@audrasjb I've added 57069.7.diff to bring it in line with docblock formatting standards and to add a type for $wp_customize
. Do you have time to take a look at this one? 🙂
Thanks for the ticket and patch!
patch 57069.patch look fine to me. It removes unnecessary global declaration.
Ping @audrasjb for final review and commit.