WordPress.org

Make WordPress Core

Opened 5 months ago

Closed 2 months 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
Milestone: 4.9 Priority: normal
Severity: normal Version:
Component: HTTP API Keywords: has-patch
Focuses: docs Cc:

Description

Documentation needs improvement.parameter passed but not defined.

Attachments (1)

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

Download all attachments as: .zip

Change History (10)

@ronakganatra
5 months ago

documentation added for parameter which is passed but not defined.

#1 @ronakganatra
5 months ago

  • Keywords has-patch added

#2 @ronakganatra
5 months ago

  • Keywords has-patch removed

#3 @ronakganatra
5 months ago

  • Keywords has-patch added

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


5 months ago

#5 @DrewAPicture
5 months ago

  • Owner set to DrewAPicture
  • Resolution set to fixed
  • Status changed from new to 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
5 months ago

  • Milestone changed from Awaiting Review to 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
5 months ago

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

#8 @SergeyBiryukov
5 months ago

  • Resolution fixed deleted
  • Status changed from closed to 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 5 months ago by SergeyBiryukov (previous) (diff)

#9 @SergeyBiryukov
2 months ago

  • Resolution set to fixed
  • Status changed from reopened to 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.