WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 4 years ago

#28298 closed task (blessed) (fixed)

Improve inline docs for functional default arguments throughout core

Reported by: DrewAPicture Owned by:
Milestone: 4.1 Priority: normal
Severity: normal Version:
Component: General Keywords:
Focuses: docs Cc:

Description

This ticket will serve as a tracking ticket for documenting functional args arrays throughout core.

Attachments (3)

28298.register_sidebar.diff (2.4 KB) - added by coffee2code 5 years ago.
Convert documentation for default arguments in register_sidebar() to a hash notation.
28298.register_sidebars.diff (1.9 KB) - added by coffee2code 5 years ago.
Add documentation for default arguments in register_sidebars().
28298.the_widget.diff (1.5 KB) - added by coffee2code 5 years ago.
Add documentation for default arguments in the_widget(). (Plus minor formatting tweaks to the function's other @params.)

Download all attachments as: .zip

Change History (21)

#1 @DrewAPicture
5 years ago

In 28474:

Add inline documentation for default arguments in wp_insert_category().

See #28298.

#2 @DrewAPicture
5 years ago

In 28476:

Improve inline documentation for default arguments in wp_get_archives().

See #28298.

#3 @DrewAPicture
5 years ago

In 28498:

Improve inline documentation of default arguments for the_title_attribute().

See #28298.

#4 @DrewAPicture
5 years ago

In 28499:

Improve inline documentation of default arguments for post_format_meta_box(), post_tags_meta_box(), and post_categories_meta_box().

See #28298.

#5 @DrewAPicture
5 years ago

In 29230:

Convert documentation for default arguments in WP_Http::request() to a hash notation.

Also update corresponding docs for functions that leverage its arguments.

See #28298.

#6 @DrewAPicture
5 years ago

In 29459:

Document default arguments for the WP_List_Table class. Also add referenced docblocks to extending class constructors.

Props mikejolley for the initial patch.
Fixes #28679. See #28298.

This ticket was mentioned in IRC in #wordpress-dev by DrewAPicture. View the logs.


5 years ago

#8 @DrewAPicture
5 years ago

In 30722:

Use the correct hash notation syntax for the WP_Filesystem_Base::dirlist() DocBlock.

See #28298.

#9 @DrewAPicture
5 years ago

In 30723:

Use the correct hash notation syntax for the get_pages() DocBlock.

See #28298.

#10 @DrewAPicture
5 years ago

In 30724:

Use the correct hash notation syntax for the wp_insert_term() DocBlock.

See #28298.

#11 @DrewAPicture
5 years ago

In 30725:

Improve formatting of inline documentation for get_pages().

Adds missing default values, corrects several argument types, backtick-escapes argument names used in descriptions.

See #28298.

@coffee2code
5 years ago

Convert documentation for default arguments in register_sidebar() to a hash notation.

@coffee2code
5 years ago

Add documentation for default arguments in register_sidebars().

@coffee2code
5 years ago

Add documentation for default arguments in the_widget(). (Plus minor formatting tweaks to the function's other @params.)

#12 @coffee2code
5 years ago

Handled the remaining hash notation-related fixes for src/wp-includes/widgets.php:

  • 28298.register_sidebar.diff converts register_sidebar() default argument docs to hash notation
  • 28298.register_sidebars.diff adds default argument docs for register_sidebars()
  • 28298.the_widget.diff adds default argument docs for the_widget(). Also minor formatting tweaks to the existing @param docs (to include: adding “Optional.”, adding ending periods, capitalizing descriptions, aligning descriptions, removing “@return void”)

#13 @coffee2code
5 years ago

  • Keywords has-patch added

#14 @DrewAPicture
5 years ago

In 30745:

Document the default arguments for register_sidebar() in the hash notation style.

Props coffee2code.
See #28298.

#15 @DrewAPicture
5 years ago

In 30769:

Document the default arguments for register_sidebars() in the hash notation style.

Props coffee2code.
See #28298.

#16 @DrewAPicture
5 years ago

In 30770:

Document the default arguments for the_widget() in the hash notation style.

Props coffee2code.
See #28298.

#17 @DrewAPicture
5 years ago

  • Keywords has-patch removed

[30745], [30769], and [30770] cover the three patches from @coffee2code.

#18 @DrewAPicture
4 years ago

  • Milestone changed from Future Release to 4.1
  • Resolution set to fixed
  • Status changed from new to closed

Let's call this fixed as of 4.1. New tickets for new arguments.

Note: See TracTickets for help on using tickets.