WordPress.org
Get WordPress

Make WordPress Core

Opened 11 years ago

Closed 11 years ago

#34960 closed defect (bug) (fixed)

Improve wp_debug_mode() function documentation.

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

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 11 years ago.
34960.2.patch​ (750 bytes ) - added by SergeyBiryukov 11 years ago.

Download all attachments as: .zip

Change History (7)

@jrf
11 years ago

#1 @jrf
11 years ago

  • Keywords has-patch added
  • Severity normal → minor

#2 @SergeyBiryukov
11 years ago

  • Milestone Awaiting Review → 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.

@SergeyBiryukov
11 years ago

#4 @jrf
11 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
11 years ago

  • Owner set to SergeyBiryukov
  • Resolution → fixed
  • Status new → 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.