WordPress.org

Make WordPress Core

Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#35986 closed task (blessed) (fixed)

4.5 Docs Audit

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

Description


Change History (64)

#1 @DrewAPicture
4 years ago

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

#2 @DrewAPicture
4 years ago

In 36819:

Docs: Match the parameter name in the hook docs for the press_this_useful_html_elements filter, introduced in [36672].

See #34455. See #35986.

#3 @DrewAPicture
4 years ago

In 36820:

Docs: Use third-person singular verbs in DocBlock summaries for the WP_Site_Logo class, introduced in [36698].

Also minorly improves various inline docs.

See #33755. See #35986.

#4 @DrewAPicture
4 years ago

In 36821:

Docs: Improve documentation for WP_Upgrader::create_lock(), introduced in [36349].

See #34878. See #35986.

#5 @DrewAPicture
4 years ago

In 36822:

Docs: Improve documentation for WP_Upgrader::release_lock(), introduced in [36349].

See #34878. See #35986.

#6 @DrewAPicture
4 years ago

In 36823:

Docs: Add a more descriptive changelog entry to the hook doc for the privacy_on_link_title filter.

See #35049. See #35986.

#7 @DrewAPicture
4 years ago

In 36824:

Docs: Minorly improve the hook doc summary for the pre_uninstall_plugin action, introduced in [36124].

See #34569. See #35986.

#8 @DrewAPicture
4 years ago

In 36825:

Docs: Improve documentation for upgrade_450(), introduced in [36180].

See #27772, #35323. See #35986.

#9 @DrewAPicture
4 years ago

In 36826:

Docs: Minorly improve the hook doc summary for the pre_network_site_new_created_user action, introduced in [35786].

See #33631. See #35986.

#10 @swissspidy
4 years ago

In 36827:

Docs: Improve documentation for the update_welcome_user_email() filter, introduced in [26538].

See #25598. See #35986.

#11 @swissspidy
4 years ago

In 36828:

Docs: Move the hook doc for the all_plugins filter in WP_Plugins_List_Table::prepare_items() to directly precede the apply_filters() line.

See #35986.

#12 @DrewAPicture
4 years ago

In 36833:

Docs: Improve the DocBlock summary and add a missing initial @since version for WP_Admin_Bar::add_node().

See #32246. See #35986.

#13 @DrewAPicture
4 years ago

In 36834:

Docs: Standardize the changelog entry for the new $author_url argument, introduced in [36224].

See #35377. See #35986.

#14 @DrewAPicture
4 years ago

In 36835:

Docs: Improve documentation for WP_Customize_Nav_Menus::filter_nonces(), introduced in [36414].

See #27355, #35617. See #35986.

#15 @DrewAPicture
4 years ago

In 36836:

Docs: Improve DocBlock syntax for WP_Customize_Nav_Menus::customize_dynamic_partial_args(), introduced in [36586].

See #27355. See #35986.

#16 @DrewAPicture
4 years ago

In 36840:

Docs: Remove an errant period following the @access tag in the DocBlock for wpdb::close(), mistakenly introduced in [36493].

Props markoheijnen.
See #34903. See #35986.

#17 @DrewAPicture
4 years ago

In 36841:

Docs: Improve documentation for WP_Customize_Widgets::customize_dynamic_partial_args(), introduced in [36586].

See #27355. See #35986.

#18 @DrewAPicture
4 years ago

In 36842:

Docs: Improve syntax and correct documentation throughout a variety of methods in WP_Customize_Widgets.

See #32246. See #35986.

#19 @DrewAPicture
4 years ago

In 36846:

Docs: Improve the hook doc summary for the image_strip_meta filter, introduced in [36700].

See: #33642, #30402, #28634. See #35986.

#20 @DrewAPicture
4 years ago

In 36847:

Docs: Improve DocBlock syntax and add a missing @return notation for WP_Image_Editor_Imagick::strip_meta(), introduced in [36700].

See: #33642, #30402, #28634. See #35986.

#21 @DrewAPicture
4 years ago

In 36897:

Docs: Add a missing file header to wp-includes/class-wp-metadata-lazyloader.php, introduced in [36566].

See #35816. See #35986.

#22 @DrewAPicture
4 years ago

In 36898:

Docs: Improve inline documentation syntax throughout WP_Metadata_Lazyloader, introduced in [36566].

See #35816. See #35986.

#23 @DrewAPicture
4 years ago

In 36899:

Docs: Standardize file header summary for wp-includes/class-wp-metadata-lazyloader.php.

See [36897]. See #35986.

#24 @DrewAPicture
4 years ago

In 36900:

Docs: Improve the DocBlock summary for WP::remove_query_var(), introduced in [36177].

See #35234. See #35986.

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


4 years ago

#26 @DrewAPicture
4 years ago

In 36917:

Docs: Add a missing DocBlock summary for the WP_Scripts->print_html_before property, added in [36633].

See #14853. See #35986.

#27 @DrewAPicture
4 years ago

In 36918:

Docs: Improve the usefulness of associated reference info in the hook doc for the comments_template_query_args filter, introduced in [36235].

See #34442. See #35986.

#28 @DrewAPicture
4 years ago

In 36919:

Docs: Improve the DocBlock summary for wp_queue_comments_for_comment_meta_lazyload(), introduced in [36566].

See #35816. See #35986.

#29 @DrewAPicture
4 years ago

In 36920:

Docs: Improve the DocBlock summary for wp_get_comment_fields_max_lengths(), introduced in [36514].

See #10377. See #35986.

#30 @DrewAPicture
4 years ago

In 36921:

Docs: Improve syntax for the $lengths parameter in the hook doc for the wp_get_comment_fields_max_lengths filter, introduced in [36272].

See #10377. See #35986.

#31 @DrewAPicture
4 years ago

In 36922:

Docs: Improve the DocBlock summary for the clean_comment_cache action, introduced in [36405].

See #35610. See #35986.

#32 @DrewAPicture
4 years ago

In 36923:

Docs: Improve the DocBlock summary for the_embed_site_title(), introduced in [36693].

See #34561. See #35986.

#33 @DrewAPicture
4 years ago

In 36925:

Docs: Improve DocBlock syntax for wp_get_upload_dir(), introduced in [36565].

See #34359. See #35986.

#34 @DrewAPicture
4 years ago

In 36936:

Docs: Improve inline documentation for has_custom_logo(), introduced in [36698].

See #33755. See #35986.

#35 @DrewAPicture
4 years ago

In 36937:

Docs: Improve the $blog_id parameter description in the DocBlock for get_custom_logo(), introduced in [36698].

See #33755. See #35986.

#36 @DrewAPicture
4 years ago

In 36938:

Docs: Improve the $blog_id parameter description in the DocBlock for the_custom_logo(), introduced in [36698].

See #33755. See #35986.

#37 @DrewAPicture
4 years ago

In 36939:

Docs: Improve the 4.5.0 changelog entry in the hook doc for the get_archives_link filter, introduced in [36418].

See #35573. See #35986.

#38 @DrewAPicture
4 years ago

In 36941:

Docs: Improve the DocBlock summary for wp_metadata_lazyloader(), introduced in [36566].

See #35816. See #35986.

#39 @DrewAPicture
4 years ago

In 36944:

Docs: Improve the accuracy of the return description for unregister_post_type(), introduced in [36316].

See #14761. See #35986.

#40 @DrewAPicture
4 years ago

In 36945:

Docs: Improve the DocBlock summary for wp_queue_posts_for_term_meta_lazyload(), introduced in [36566].

See #35816. See #35986.

#41 @DrewAPicture
4 years ago

In 36947:

Docs: Improve syntax in the DocBlock for rest_get_server(), introduced in [36529].

See #35329. See #35986.

#42 @DrewAPicture
4 years ago

In 36960:

Docs: Use a third-person singular verb for the DocBlock summary for remove_permastruct(), introduced in [36181].

See #35235. See #35986.

#43 @DrewAPicture
4 years ago

In 36961:

Docs: Improve the summary and return description in the DocBlock for unregister_taxonomy(), introduced in [36243].

See #35227. See #35986.

#44 @DrewAPicture
4 years ago

In 36962:

Docs: Improve changelog entries added for the delete_term and delete_{$taxonomy} actions in [36080] and a third entry added for the clean_term_cache action in [36399]

See #35213, #35611. See #35986.

#45 @DrewAPicture
4 years ago

In 36963:

Docs: Use a third-person singular verb in the summary for get_embed_template(), introduced in [36876].

See #34561, #34278. See #35986.

#46 @DrewAPicture
4 years ago

In 36965:

Docs: Correct a typo in the DocBlock summary for get_embed_template(), introduced in [36963].

Props swissspidy.
See #34561, #34278. See #35986.

#47 @DrewAPicture
4 years ago

In 36966:

Docs: Improve two 4.5.0 changelog entries added for the plugins_update_check_locales and themes_update_check_locales filters, introduced in [36630].

See #34937. See #35986.

#48 @johnbillion
4 years ago

In 36992:

Users: Add @since entries to wp_authenticate() and its filters now that the $username parameter can also be an email address.

See #9568, #35986

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


4 years ago

#50 @DrewAPicture
4 years ago

In 37006:

Docs: Add a couple of spaces before hook docs for filters introduced in 4.5.

See #35986.

#51 @DrewAPicture
4 years ago

In 37007:

Docs: Use a third-person singular verb in the DocBlock summary for wp_authenticate_email_password(), introduced in [36617].

See #9568. See #35986.

#52 @DrewAPicture
4 years ago

In 37008:

Docs: Clarify the use of the get_currentuserinfo() for backward compatibility purposes in the DocBlock description for _wp_get_current_user(), introduced in [36651].

See #19615. See #35986.

#53 @DrewAPicture
4 years ago

In 37009:

Docs: Standardize the file header and class summaries for the file containing WP_Customize_Partial, introduced in [36586].

See #27355. See #35986.

#54 @DrewAPicture
4 years ago

In 37010:

Docs: Standardize the file header and class summarries for the file containing WP_Customize_Selective_Refresh, introduced in [36586].

See #27355. See #35986.

#55 @DrewAPicture
4 years ago

In 37011:

Docs: Add a missing version and access information to the DocBlock for the WP_Customize_Selective_Refresh->$manager property, introduced in [36586].

See #27355. See #35986.

#56 @DrewAPicture
4 years ago

In 37012:

Docs: Use a third-person singular verb in the DocBlock summary for WP_Customize_Site_Icon_Control::content_template(), introduced in [36698].

Also adds a missing @access notation.

See #33755. See #35986.

#57 @DrewAPicture
4 years ago

In 37013:

Docs: Improve the DocBlock for WP_REST_Request::from_url(), introduced in [36673].

See #35803. See #35986.

#58 @DrewAPicture
4 years ago

In 37014:

Docs: Improve parameter description syntax in the hook doc for the rest_request_from_url filter, introduced in [36673].

See #35803. See #35986,

#59 @DrewAPicture
4 years ago

In 37015:

Docs: Use a third-person singular verb in the DocBlock summary for WP_REST_Response::get_curies(), introduced in [36533].

Also adds a missing return description.

See #34729. See #35986.

#60 @DrewAPicture
4 years ago

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

Let's call this fixed. New tickets for any other 4.5 docs issues that might arise.

#61 @DrewAPicture
4 years ago

In 37030:

Docs: Improve 4.5 changelog entries introduced in [36992] for wp_authenticate(), and the authenticate and wp_login_failed hooks.

See #9568. See #35986.

#62 @DrewAPicture
4 years ago

In 37038:

Docs: Add Twitter timelines and moments to the table in the hook doc for the oembed_provders filter, introduced in [36954].

See #36197. See #35986.

#63 @DrewAPicture
4 years ago

In 37087:

Docs: Reference the correct embed templates and template parts filenames in headers for embed files introduced or changed in 4.5.

See [36693], #34561. See #35986. Fixes #36352.

#64 @DrewAPicture
4 years ago

In 37088:

Docs: Standardize file headers for two embed templates introduced in [36693] for #34561.

Props flixos90.
Also missed props for flixos90 on [37087].

See #35986. See #36352.

Note: See TracTickets for help on using tickets.