WordPress.org

Make WordPress Core

Opened 5 weeks ago

Last modified 3 weeks ago

#48357 reviewing defect (bug)

Improve documentation for wp-includes/option.php

Reported by: leogermani Owned by: SergeyBiryukov
Milestone: 5.4 Priority: normal
Severity: normal Version:
Component: Options, Meta APIs Keywords: good-first-bug has-patch
Focuses: docs Cc:
PR Number:

Description

In the update_option documentation, since the $autoload parameter is added, the sentence below is incorrect:

If the option does not exist, then the option will be added with the option value, with an $autoload value of 'yes'.

Actually it will be added with whatever was passed to the $autoload parameter, 'yes' being only the default value.

This ticket/patch proposes a new text for the function description and for the documentation of the $autoload argument.

Attachments (1)

48357.diff (1.8 KB) - added by leogermani 5 weeks ago.

Download all attachments as: .zip

Change History (5)

#1 @desrosj
5 weeks ago

  • Keywords good-first-bug needs-patch added
  • Milestone changed from Awaiting Review to 5.4

Thanks for this, @leogermani. Are you interested in creating a patch?

#2 @leogermani
5 weeks ago

  • Keywords has-patch added; needs-patch removed

Here it is:

https://github.com/leogermani/WordPress/pull/1

This is the first time I submit a patch with a pull request (I've heard it's possible). Do I need to do anything else?

Last edited 5 weeks ago by leogermani (previous) (diff)

@leogermani
5 weeks ago

#3 @leogermani
5 weeks ago

Apparently I was wrong and I still need to manually upload the patch.

#4 @SergeyBiryukov
3 weeks ago

  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing
Note: See TracTickets for help on using tickets.