WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#34960 closed defect (bug) (fixed)

Improve wp_debug_mode() function documentation.

Reported by: jrf Owned by: SergeyBiryukov
Milestone: 4.5 Priority: normal
Severity: minor Version:
Component: General Keywords: has-patch
Focuses: docs Cc:

Description

There is a contradiction (and falsity) in the documentation of the wp_debug_mode() function. This patch fixes that.

Attachments (2)

34960-fix-documentation.patch (1.2 KB) - added by jrf 5 years ago.
34960.2.patch (750 bytes) - added by SergeyBiryukov 5 years ago.

Download all attachments as: .zip

Change History (7)

#1 @jrf
5 years ago

  • Keywords has-patch added
  • Severity changed from normal to minor

#2 @SergeyBiryukov
5 years ago

  • Milestone changed from Awaiting Review to 4.5

WP_DEBUG_DISPLAY is set to true by default but this setting will only have an effect when WP_DEBUG is also set to true.

It's already mentioned further in the same block:

WP_DEBUG_DISPLAY and WP_DEBUG_LOG perform no function unless WP_DEBUG is true.

#4 @jrf
5 years ago

I'd be happy with either. As long as it is clear that the default for WP_DEBUG_DISPLAY is true not false (as the code in master now wrongly states).

#5 @SergeyBiryukov
5 years ago

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

In 35882:

Docs: Correct wp_debug_mode() description to clarify that WP_DEBUG_DISPLAY is true by default.

Props jrf.
Fixes #34960.

Note: See TracTickets for help on using tickets.