Opened 3 years ago
Last modified 3 years ago
#42156 reviewing enhancement
Adjust the inline docs for get_sites() to avoid WP_Site_Query doc-duplication
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | Awaiting Review | Priority: | normal |
Severity: | normal | Version: | 4.6 |
Component: | Networks and Sites | Keywords: | good-first-bug has-patch |
Focuses: | docs, multisite | Cc: |
Description
The get_sites()
is a wrapper for a WP_Site_Query
object, so to avoid doc duplication, we should adjust the inline docs for that function.
Similar to what has been done for the documentation of the get_posts()
function, that's a wrapper for a WP_Query
object.
Code reference:
get_sites()
:
https://core.trac.wordpress.org/browser/tags/4.8/src/wp-includes/ms-blogs.php#L588
WP_Site_Query
:
https://core.trac.wordpress.org/browser/tags/4.8/src/wp-includes/class-wp-site-query.php#L105
get_posts()
:
https://core.trac.wordpress.org/browser/tags/4.8/src/wp-includes/post.php#L1646
Related #42117
Attachments (2)
Change History (8)
#3
@
3 years ago
- Keywords has-patch added; needs-patch removed
This is my first contribution, so please tell me if I'm doing something wrong :)
#4
@
3 years ago
Thanks for the patch @felipeelia
That looks good to me - I'm just wondering if we should keep it in one line, instead of two.
Wasn't there any recommended maximum length of comments? It would be informative to check that.
I think this would be a good-first-bug, but I can't mark it as such.