WordPress.org

Make WordPress Core

Opened 2 months ago

Last modified 2 months ago

#42156 new enhancement

Adjust the inline docs for get_sites() to avoid WP_Site_Query doc-duplication

Reported by: birgire 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)

42156.diff (4.7 KB) - added by felipeelia 2 months ago.
42156.2.diff (4.7 KB) - added by felipeelia 2 months ago.

Download all attachments as: .zip

Change History (7)

#1 @birgire
2 months ago

I think this would be a good-first-bug, but I can't mark it as such.

#2 @johnbillion
2 months ago

  • Keywords needs-patch good-first-bug added

@felipeelia
2 months ago

#3 @felipeelia
2 months ago

  • Keywords has-patch added; needs-patch removed

This is my first contribution, so please tell me if I'm doing something wrong :)

#4 @birgire
2 months 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.

@felipeelia
2 months ago

#5 @felipeelia
2 months ago

Thanks @birgire!

I found a recommendation here. It can be 120 characters wide, maintaining it in one line we get just 108 (with indentation).

Note: See TracTickets for help on using tickets.