WordPress.org

Make WordPress Core

Opened 4 years ago

Closed 4 years ago

Last modified 17 months ago

#31888 closed task (blessed) (fixed)

4.2: Inline Docs audit

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

Description


Change History (44)

#1 @DrewAPicture
4 years ago

  • Owner set to DrewAPicture
  • Status changed from new to accepted

#2 @DrewAPicture
4 years ago

In 32003:

Fix Docblock syntax for the taxonomy_parent_dropdown_args filter.

See [30998]. See #31888

#3 @DrewAPicture
4 years ago

In 32005:

Add a more descriptive function summary for options_discussion_add_js().

See [31095]. See #31888.

#4 @DrewAPicture
4 years ago

In 32006:

Add an @see mention for Plugin_Upgrader, plus spacing to the wp_ajax_update_plugin() delcaration.

See #31888.

#5 @DrewAPicture
4 years ago

In 32007:

Fix typos in the function summaries for wp_ajax_press_this_save_post() and wp_ajax_press_this_add_category().

See [31534]. See #31888.

#6 @DrewAPicture
4 years ago

In 32009:

Add a return description to the DocBlock for WP_Posts_List_Table->is_base_request().

See [31828]. See #31888.

#7 @DrewAPicture
4 years ago

In 32010:

Fix syntax for the $to_display parameter description in the DocBlock for WP_Posts_List_Table->_page_rows().

See [31730]. See #31888.

#8 @DrewAPicture
4 years ago

In 32011:

Fix filter doc vernacular for the quick_edit_show_taxonomy filter.

See [31308]. See #31888.

#9 @DrewAPicture
4 years ago

In 32013:

Add missing DocBlocks for the _limit_array(), _limit_string(), _limit_url(), _limit_img(), _limit_embed(), and _process_meta_entry() utility methods in WP_Press_This.

See [31609]. See #31888.

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


4 years ago

#11 @DrewAPicture
4 years ago

In 32014:

Add missing @since versions from a variety of methods in WP_Press_This.

See [31693]. See #31888.

#12 @DrewAPicture
4 years ago

In 32015:

Clarify 4.2.0 changelog entry, add global description to the DocBlock for WP_Users_List_Table->single_row().

See #31888.

#13 @DrewAPicture
4 years ago

In 32016:

Clarify the DocBlock description for wp_print_request_filesystem_credentials_modal().

See [31811]. See #31888.

#14 @DrewAPicture
4 years ago

In 32018:

Add proper descriptions for the @global and @param tags in the wp_media_attach_action() DocBlock.

See [31619]. See #31888.

#15 @DrewAPicture
4 years ago

In 32019:

Clarify the DocBlock summary and parameter description for wp_edit_attachments_query_vars().

See [31037]. See #31888.

#16 @DrewAPicture
4 years ago

In 32020:

The value_field argument is an argument per core vernacular, not a parameter.

See [31006]. See #31888.

#17 @DrewAPicture
4 years ago

In 32023:

Add documentation for the $type, $mime_type, and $button_labels properties in WP_Customize_Media_Control.

See [31698]. See #31888.

#18 @DrewAPicture
4 years ago

In 32026:

Fix description alignment for the category_css_class filter docs.

See [31027]. See #31888.

#19 @SergeyBiryukov
4 years ago

In 32027:

wp_install_maybe_enable_pretty_permalinks() should have a consistent @return value.

props DrewAPicture.
fixes #6481. see #31888.

#20 @DrewAPicture
4 years ago

In 32028:

Add documentation for the $type and $theme properties in WP_Customize_Theme_Control.

Also add some missing @access tags to various DocBlocks.

See [31533]. See #31888.

#21 @DrewAPicture
4 years ago

In 32030:

Add inline doc syntax fixes for WP_Customize_Manager->doing_ajax().

Also adds a return description.

See [31370]. See #31888.

#22 @DrewAPicture
4 years ago

In 32031:

Cleanup DocBlock syntax, add a missing parameter description for WP_Customize_Manager->set_post_value().

See [31370]. See #31888.

#23 @DrewAPicture
4 years ago

In 32032:

Fix inline documentation syntax in a variety of DocBlocks and hook docs in WP_Customize_Manager.

See [31370]. See #31888.

#24 @DrewAPicture
4 years ago

In 32033:

Document the $theme property in WP_Customize_Themes_Section.

Also adds a missing @access tag to the DocBlock for WP_Customize_Themes_Section->render().

See [31533]. See #31888.

#25 @DrewAPicture
4 years ago

In 32034:

Add missing @access tags to two DocBlocks in WP_Customize_Setting.

See [31707]. See #31888.

#26 @DrewAPicture
4 years ago

In 32035:

Add parameter and return descriptions for WP_Customize_Widgets->get_setting_type().

See [31370]. See #31888.

#27 @DrewAPicture
4 years ago

In 32036:

Add missing parameter and return descriptions to WP_Customize_Widgets->filter_customize_dynamic_setting_args().

See [31370]. See #31888.

#28 @DrewAPicture
4 years ago

In 32037:

Remove backtick-escaping around a core function in the hook docs for the comment_form_submit_field filter.

See [31699]. See #31888.

#29 @DrewAPicture
4 years ago

In 32038:

Remove an unnecessary inline @see tag and document the $wpdb global in two WP_Comment_Query methods.

See [31793]. See #31888.

#30 @DrewAPicture
4 years ago

In 32039:

Various docs syntax fixes in wp-includes/formatting.php.

See #31888.

#31 @DrewAPicture
4 years ago

In 32040:

Add a variety of missing descriptions and fix syntax for wp_scripts(), _wp_scripts_maybe_doing_it_wrong(), and wp_script_add_data().

See #31888.

#32 @DrewAPicture
4 years ago

In 32041:

Add a missing return description for wp_styles().

See [31194]. See #31888.

#33 @DrewAPicture
4 years ago

In 32042:

Various inline documentation syntax fixes in wp-includes/link-template.php.

See #31888.

#34 @DrewAPicture
4 years ago

In 32043:

Remove unneeded spaces in the hook doc for the attachment_url_to_postid filter.

See [31867]. See #31888.

#35 @DrewAPicture
4 years ago

In 32044:

Add a missing @access tag to the DocBlock for the WP_Meta_Query->$clauses property.

Also adds a missing return description for WP_Meta_Query::get_clauses().

See [31312]. See #31888.

#36 @DrewAPicture
4 years ago

In 32045:

Various inline documentation syntactical fixes in wp-includes/pluggable.php for 4.2 changes.

See #31888.

#37 @DrewAPicture
4 years ago

In 32046:

Variously inline documentation syntactical fixes in wp-includes/post-template.php.

See #31888.

#38 @DrewAPicture
4 years ago

In 32047:

Fix a variety of inline documentation syntactical issues in wp-includes/taxonomy.php.

See #31888.

#39 @DrewAPicture
4 years ago

In 32048:

Add a missing return description for has_header_image().

See [31224]. See #31888.

#40 @DrewAPicture
4 years ago

In 32049:

Remove unnecessary inline @see tags from the wpdb::process_field_charsets() DocBlock.

See [30345]. See #31888.

#41 @DrewAPicture
4 years ago

In 32050:

Remove unnecessary inline @see tags from a variety of parameter and return descriptions in wp-includes/wp-db.php.

See #31888.

#42 @DrewAPicture
4 years ago

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

#43 @westonruter
4 years ago

In 35534:

Customize: Correct phpdoc @return type for WP_Customize_Manager::add_dynamic_settings().

Fixes regression in [32032], where WP_Customize_Setting[] should have been changed to array instead of WP_Customize_Setting.

See #31888.

#44 @SergeyBiryukov
17 months ago

In 43023:

Docs: Remove backtick-escaping around a core function in the hook docs for the comment_form_submit_button filter.

This allows the function to be auto-linked in the Developer Reference. See [32037] for comment_form_submit_field.

See #42505, #31888.

Note: See TracTickets for help on using tickets.