Make WordPress Core

Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#49477 closed enhancement (fixed)

Update inline documentation for WPDB

Reported by: themiked's profile theMikeD Owned by: johnbillion's profile johnbillion
Milestone: 5.5 Priority: normal
Severity: normal Version:
Component: Database Keywords: has-patch
Focuses: docs Cc:


Having accurate documentation is critical for developers, especially for complex and core functionality such as the wpdb class. We on the documentation team have been working to update the docs, and it is now wpdb's turn to be reviewed.

The wpdb page in the official docs includes parts taken from the code, some of which is either formatted incorrectly, misleading, or incorrect. This ticket will track the update to the code to fix the inline docs and docblocks so that its documentation( is accurate.

The changes include:

Note that there are only comment changes in this patch.

Attachments (2)

49477.diff (53.4 KB) - added by theMikeD 4 years ago.
49477_1.diff (52.5 KB) - added by theMikeD 4 years ago.

Download all attachments as: .zip

Change History (10)

4 years ago

4 years ago

This ticket was mentioned in Slack in #docs by themiked. View the logs.

4 years ago

#2 @SergeyBiryukov
4 years ago

  • Component changed from Comments to Database

#3 @SergeyBiryukov
4 years ago

  • Milestone changed from Awaiting Review to 5.5
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

This ticket was mentioned in Slack in #docs by themiked. View the logs.

4 years ago

#5 @theMikeD
4 years ago

Gentle nudge. Can this get into 5.5?

#6 @johnbillion
4 years ago

  • Owner changed from SergeyBiryukov to johnbillion
  • Version 5.4 deleted

#7 @johnbillion
4 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 47740:

Docs: Update inline documentation for the wpdb class.

Props theMikeD

Fixes #49477

#8 @johnbillion
4 years ago

Thanks for these updates @theMikeD! All looking good.

I made one change which is to remove the vertical alignment of the @return statements because this isn't something that the core inline documentation standard includes.

Note: See TracTickets for help on using tickets.