WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#37562 closed task (blessed) (fixed)

Docs: clarify @since entries added in 4.6

Reported by: johnbillion Owned by: johnbillion
Milestone: 4.6 Priority: normal
Severity: normal Version: 4.6
Component: General Keywords: has-patch
Focuses: docs Cc:

Description

After discussing with @drewapicture, some of the @since documentation added in 4.6 should be corrected, clarified, or converted to @internal entries.

Attachments (3)

37562.patch (4.2 KB) - added by johnbillion 3 years ago.
37562.2.patch (4.0 KB) - added by johnbillion 3 years ago.
37562.3.patch (4.0 KB) - added by johnbillion 3 years ago.

Download all attachments as: .zip

Change History (10)

@johnbillion
3 years ago

#1 @johnbillion
3 years ago

  • Keywords has-patch 2nd-opinion added; needs-patch removed

#2 @DrewAPicture
3 years ago

  • Keywords 2nd-opinion removed

In retrospect, I'm not actually sure the conversion to get_sites() is even noteworthy enough for internal notes. Let's drop them altogether.

As for the two entries in the wp_get_network(), it's basically redundant. Let's drop the changelog entry for 4.4.0 and just stick with the 4.6.0 entry.

#3 @ocean90
3 years ago

  • Keywords needs-refresh added

This needs to be reflected in the handbook first:

If significant changes have been made to a function […] additional @since tags, versions, and descriptions should be added to provide a changelog for that function.

“Significant changes” include but are not limited to:

  • […]
  • Functions or methods becoming wrappers for new APIs

https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#since-section-changelogs

@johnbillion
3 years ago

#4 @johnbillion
3 years ago

  • Keywords needs-refresh removed

@johnbillion
3 years ago

This ticket was mentioned in Slack in #core by ocean90. View the logs.


3 years ago

#6 @johnbillion
3 years ago

  • Owner set to johnbillion
  • Resolution set to fixed
  • Status changed from new to closed

In 38201:

Docs: Correct and clarify various @since docs.

Fixes #37562

#7 @johnbillion
3 years ago

In 38202:

Docs: Correct and clarify various @since docs.

Fixes #37562

Merges [38201] to the 4.6 branch.

Note: See TracTickets for help on using tickets.