WordPress.org

Make WordPress Core

Opened 4 years ago

Closed 4 years ago

#32891 closed task (blessed) (fixed)

4.3 Inline Docs audit

Reported by: DrewAPicture Owned by: DrewAPicture
Milestone: 4.3 Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch
Focuses: docs Cc:
PR Number:

Description


Change History (53)

#1 @DrewAPicture
4 years ago

  • Owner set to DrewAPicture
  • Status changed from new to accepted
  • Summary changed from 4.3: Inline Docs audit to 4.3 Inline Docs audit

#2 @DrewAPicture
4 years ago

In 33176:

Fix filter doc vernacular for the new wp_ajax_cropped_attachment_id hook added in 4.3.

See #32891.

#3 @DrewAPicture
4 years ago

In 33177:

Fix the summary and add a missing variable in the hook docs for the edit_comment_misc_actions filter.

See [32929]. See #32891.

#4 @DrewAPicture
4 years ago

In 33178:

Fix the summaries for a few methods and hooks added to WP_List_Table in 4.3.

See [32644]. See #32891.

#5 @DrewAPicture
4 years ago

In 33179:

Add missing summaries and @access tags to methods added to WP_Media_List_Table in 4.3.

See [32754]. See #32891.

#6 @DrewAPicture
4 years ago

In 33193:

Add missing summaries to new methods added to WP_MS_Themes_List_Table in 4.3.

See [32756]. See #32891.

#7 @DrewAPicture
4 years ago

In 33195:

Add missing summaries and parameter descriptions to new methods added to WP_MS_Users_List_Table in 4.3.

See [32757]. See #32891.

#8 @DrewAPicture
4 years ago

In 33196:

Fix the DocBlock summary for WP_Plugins_List_Table->get_primary_column_name(), added in 4.3.

See [32644]. See #32891.

#9 @DrewAPicture
4 years ago

In 33197:

Add missing summaries, @access tags, and some parameter descriptions to methods added to WP_Posts_List_Table in 4.3.

See [32740]. See #32891.

#10 @DrewAPicture
4 years ago

In 33198:

Improving formatting for various pieces of inline documentation in the new WP_Site_Icon class added in 4.3.

See [32994]. See #32891.

#11 @DrewAPicture
4 years ago

In 33199:

Add missing summaries, @access tags, and some parameter descriptions for methods added to WP_MS_Sites_List_Table in 4.3.

See [32755]. See #32891.

#12 @DrewAPicture
4 years ago

In 33200:

Add true descriptions to parameters for the add() method for wptextpattern, added in 4.3.

See [32703]. See #32891.

#13 @DrewAPicture
4 years ago

In 33201:

Minor documentation fixes for the wp.a11y.speak() and addContainer() DocBlocks.

See [33000]. See #32891.

#14 @DrewAPicture
4 years ago

In 33203:

Add a true return description to the test() method added to wpEmoji in 4.3.

See [32335]. See #32891.

#15 @DrewAPicture
4 years ago

In 33204:

Add missing summaries, @access tags, and some parameter descriptions for methods added to WP_Links_List_Table in 4.3.

See [32753]. See #32891.

#16 @DrewAPicture
4 years ago

In 33205:

Re-add parameter names to the add() DocBlock in wptextpattern accidentally replaced only with descriptions in [33200].

Props iseulde.
See #32891.

#17 @DrewAPicture
4 years ago

In 33207:

Fix summaries for two methods added to WP_Terms_List_Table in 4.3.

See [32644]. See #32891.

#18 @DrewAPicture
4 years ago

In 33209:

Fix inline documentation syntax in the WP_Upgrader->clear_destination() method added in 4.3.

See [32854]. See #32891.

#19 @DrewAPicture
4 years ago

In 33210:

Fix the summary for the WP_Users_List_Table->get_default_primary_column_name() method added in 4.3.

See [32644]. See #32891.

#20 @DrewAPicture
4 years ago

In 33211:

Add a description for the dynamic portion of the nav_menu_items_{$post_type_name}_recent filter added in 4.3.

See [32833]. See #32891.

#21 @DrewAPicture
4 years ago

In 33212:

Fix summaries and add missing @global descriptions to the upgrade_430_fix_comments() and split_all_shared_terms() functions added in 4.3.

See [33020], [32643]. See #32891.

#22 @DrewAPicture
4 years ago

In 33213:

Fix the summary and parameter description for wp_admin_bar_customize_menu() added in 4.3.

See [33130]. See #32891.

#23 @DrewAPicture
4 years ago

In 33214:

Fix summaries for for WP_User->__call() and wp_roles(), both added in 4.3.

See [32731], [32548]. See #32891.

#24 @DrewAPicture
4 years ago

In 33215:

Fix inline documentation syntax, and/or add missing @access tags for a variety of Customizer subclasses and methods added in 4.3.

See #32891.

#25 @DrewAPicture
4 years ago

In 33216:

Fix missing or inconsistent parameter descriptions for constructors in WP_Customize_Control, WP_Customize_Color_Control, WP_Customize_Media_Control, WP_Customize_Image_Control, WP_Customize_Background_Image_Control, WP_Customize_Site_Icon_Control, WP_Customizer_Header_Image_Control, and WP_Customize_Nav_Menu_Item_Control.

See #32891. See #32246.

#26 @DrewAPicture
4 years ago

In 33217:

Fix parameter descriptions for two methods added to WP_Customize_Manager in 4.3.

See [32658]. See #32891.

#27 @DrewAPicture
4 years ago

In 33218:

Fix syntax and add missing @access tags to various methods in WP_Customize_Nav_Menus, added in 4.3.

See [32806]. See #32891.

#28 @DrewAPicture
4 years ago

In 33219:

Fix syntax and add missing @access tags to a variety of methods added to WP_Customize_Nav_Menus_Panel in 4.3.

See [32855]. See #32891.

#29 @DrewAPicture
4 years ago

In 33220:

Fix syntax and add missing @access tags to a variety of methods added to WP_Customize_Section, WP_Customize_Nav_Menu_Section, and WP_Customize_New_Menu_Section in 4.3.

See [32658] and [32806]. See #32891.

#30 @DrewAPicture
4 years ago

In 33221:

Fix syntax and add missing @access tags to a variety of methods and properties in WP_Customize_Nav_Menu_Item_Setting added in 4.3.

See [32806]. See #32891.

#31 @DrewAPicture
4 years ago

In 33222:

Add a missing $html parameter variable in the hook docs for the style_loader_tag filter.

See #32246. See #32891.

#32 @DrewAPicture
4 years ago

In 33223:

Fix inline documentation syntax for get_default_comment_status(), introduced in 4.3.

See [33122]. See #32891.

#33 @DrewAPicture
4 years ago

In 33224:

Fix summaries for new feed functions added in 4.3.

See #32891.

#34 @DrewAPicture
4 years ago

In 33225:

Fix inline documentation syntax for two formatting functions added in 4.3.

See #32891.

#35 @DrewAPicture
4 years ago

In 33226:

Fix inline documentation syntax for a few general-purpose functions and hooks added in 4.3.

  • _deprecated_constructor() See [32989]
  • deprecated_constructor_trigger_error See [32989]
  • get_main_network_id() See [32775]
  • wp_post_preview_js() See [32809]

See #32891.

#36 @DrewAPicture
4 years ago

In 33227:

Fix the summary hook vernacular for the site_icon_meta_tags filter docs.

See [32994]. See #32891.

#37 @DrewAPicture
4 years ago

In 33228:

Fix inline documentation syntax in the DocBlock for get_language_attributes(), introduced in 4.3.

See [32868]. See #32891.

#38 @DrewAPicture
4 years ago

In 33229:

Fix inline documentation syntax for the language_attributes() DocBlock.

See #32246. See #32891.

#39 @DrewAPicture
4 years ago

In 33231:

Fix inline documentation syntax in the DocBlock for WP_Meta_Query->has_or_relation(), added in 4.3.

See [32713]. See #32891.

#40 @DrewAPicture
4 years ago

In 33232:

Fix the parameter description syntax in the hook docs for the wp_get_nav_menu_object filter, added in 4.3.

See #32891.

#41 @DrewAPicture
4 years ago

In 33233:

Fix the parameter description syntax in the hook docs for the wp_safe_redirect_fallback filter, added in 4.3.

See #32891.

#42 @DrewAPicture
4 years ago

In 33234:

Wrap a long changelog entry description in the DocBlock for get_post_type_labels().

See [32673]. See #32891.

#43 @DrewAPicture
4 years ago

In 33236:

Add better line wrapping and syntax improvements to the description for wp_resolve_numeric_slug_conflicts(), added in 4.3.

Also properly mark $query_vars as optional in the parameter description.

See [32648]. See #32891.

#44 @DrewAPicture
4 years ago

In 33237:

Properly mark the $query_var parameter as optional in the DocBlock for WP_Rewrite->add_endpoint().

See #32246. See #32891.

#45 @DrewAPicture
4 years ago

In 33238:

Fix formatting in the DocBlock for _split_shared_term().

See #32246. See #32891.

#46 @DrewAPicture
4 years ago

In 33239:

Fix inline documentation syntax in the DocBlock for get_singular_template(), added in 4.3.

See [32846]. See #32891.

#47 @DrewAPicture
4 years ago

In 33240:

Add an extra line before the hook doc for the editor_stylesheets filter begins.

The parser really likes it when there's breathing room.

See [32928]. See #32891.

#48 @DrewAPicture
4 years ago

In 33241:

Wrap a long changelog entry description in the DocBlock for count_user_posts().

Also clarify the description for the new $public_only parameter, added in [32523].

See #32891.

#49 @DrewAPicture
4 years ago

In 33242:

Fix the inline documentation syntax in the hook docs for the send_pass_change_email filter, added in 4.3.

See [32820]. See #32891.

#50 @DrewAPicture
4 years ago

In 33243:

Fix the inline documentation syntax in the hook docs for the send_email_change_email filter, added in 4.3.

See [32820]. See #32891.

#51 @DrewAPicture
4 years ago

In 33244:

Fix the inline documentation syntax in the hook docs for the password_change_email filter, introduced in 4.3.

See [32820]. See #32891.

#52 @DrewAPicture
4 years ago

In 33245:

Fix the inline documentation syntax in the hook docs for the email_change_email filter, introduced in 4.3.

Also update the filter summary to reflect that the file is for an "email" change, not a "password" change.

See [32820]. See #32891.

#53 @DrewAPicture
4 years ago

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

I think that about covers it. New tickets for new issues.

Note: See TracTickets for help on using tickets.