WordPress.org

Make WordPress Core

Opened 7 weeks ago

Last modified 4 weeks ago

#49477 reviewing enhancement

Update inline documentation for WPDB

Reported by: theMikeD Owned by: SergeyBiryukov
Milestone: 5.5 Priority: normal
Severity: normal Version: 5.4
Component: Database Keywords: has-patch
Focuses: docs Cc:

Description

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(https://developer.wordpress.org/reference/classes/wpdb/) 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 7 weeks ago.
49477_1.diff (52.5 KB) - added by theMikeD 7 weeks ago.

Download all attachments as: .zip

Change History (6)

@theMikeD
7 weeks ago

@theMikeD
7 weeks ago

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


7 weeks ago

#2 @SergeyBiryukov
7 weeks ago

  • Component changed from Comments to Database

#3 @SergeyBiryukov
7 weeks 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 weeks ago

Note: See TracTickets for help on using tickets.