WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

#45410 closed defect (bug) (fixed)

Docs: PHPDoc correction in wp-includes/pomo/streams.php

Reported by: ishitaka Owned by: pento
Milestone: 5.1 Priority: normal
Severity: normal Version: 5.1
Component: I18N Keywords: has-patch
Focuses: docs Cc:

Description

For setEndian() function, the parameter type should be added first and then the parameter name.

Currently

@param $endian string 'big' or 'little'

Should be

@param string $endian The endianness of the file. Accepts 'big' or 'little'.

Attachments (2)

45410.patch (494 bytes) - added by ishitaka 3 years ago.
45410.2.patch (525 bytes) - added by ishitaka 3 years ago.

Download all attachments as: .zip

Change History (8)

@ishitaka
3 years ago

#1 @ishitaka
3 years ago

  • Summary changed from Docs: PHPDoc correction in wp-includes\pomo\streams.php to Docs: PHPDoc correction in wp-includes/pomo/streams.php

#2 @mukesh27
3 years ago

  • Keywords needs-refresh added

It looks like a good improvement, as suggested by @ishitaka.

Here's are suggested adjustments for 45410.patch​:

* @param string $endian Set the endianness of the file it will accepts 'big' or 'little', defaults to little.

#3 @ishitaka
3 years ago

@mukesh27 Thanks for your suggestion. I have updated patch!

@ishitaka
3 years ago

#4 @SergeyBiryukov
3 years ago

  • Component changed from Filesystem API to I18N
  • Focuses docs added
  • Keywords needs-refresh removed
  • Milestone changed from Awaiting Review to 5.1
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

#5 @pento
3 years ago

  • Owner changed from SergeyBiryukov to pento
  • Status changed from reviewing to accepted

#6 @pento
3 years ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 44614:

Docs: Correct the docs for POMO_Reader::setEndian().

The parameter type and name where the wrong way around.

Props ishitaka.
Fixes #45410.

Note: See TracTickets for help on using tickets.