Make WordPress Core

Opened 9 years ago

Closed 9 years ago

#41380 closed defect (bug) (fixed)

Add missing docs for the $data parameter for WP_Http::browser_redirect_compatibility()

Reported by: ronakganatra Owned by: DrewAPicture
Priority: normal Milestone: 4.9
Component: HTTP API Version:
Severity: normal Keywords: has-patch
Cc: Focuses: docs

Description

Documentation needs improvement.parameter passed but not defined.

Attachments (1)

41380.patch​ (888 bytes ) - added by ronakganatra 9 years ago.
documentation added for parameter which is passed but not defined.

Download all attachments as: .zip

Change History (10)

@ronakganatra
9 years ago

documentation added for parameter which is passed but not defined.

#1 @ronakganatra
9 years ago

  • Keywords has-patch added

#2 @ronakganatra
9 years ago

  • Keywords has-patch removed

#3 @ronakganatra
9 years ago

  • Keywords has-patch added

This ticket was mentioned in ​Slack in #core by ronak.ganatra. ​View the logs.


9 years ago

#5 @DrewAPicture
9 years ago

  • Owner set to DrewAPicture
  • Resolution → fixed
  • Status new → closed

In 41218:

Docs: Add missing documentation for the $data parameter for WP_Http::browser_redirect_compatibility().

Props ronakganatra for the initial patch.
Fixes #41380.

#6 @DrewAPicture
9 years ago

  • Milestone Awaiting Review → 4.9

Hi @ronakganatra, thanks for the patch. I've gone ahead and merged part of your patch and wanted to give you a couple of pointers for future tickets:

1) It would be very helpful if you could try to write more specific ticket summaries when submitting to trac in the future. I went ahead and updated it for you here :-)

2) It would also be helpful to generate your patches from the WordPress root instead of the directory the file is located in. This is because most core contributors will be using tools like the ​grunt patch tool to apply patches, which means patches not generated from the root may not apply correctly.

#7 @DrewAPicture
9 years ago

  • Summary Documentation needs improvement. → Add missing docs for the $data parameter for WP_Http::browser_redirect_compatibility()

#8 @SergeyBiryukov
9 years ago

  • Resolution fixed
  • Status closed → reopened

This description appears to be a copy/paste from wp_cache_add(),

The $data argument of WP_Http::browser_redirect_compatibility() has nothing to do with cache, appears to be unused and could probably be deprecated to avoid further confusion. Introduced in [37428].

Last edited 9 years ago by SergeyBiryukov (previous) (diff)

#9 @SergeyBiryukov
9 years ago

  • Resolution → fixed
  • Status reopened → closed

In 41907:

Docs: Correct type and description for the $data parameter in WP_Http::browser_redirect_compatibility().

Fixes #41380.

Note: See TracTickets for help on using tickets.