WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#28885 closed task (blessed) (fixed)

Inline Docs audit for 4.0

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

Description


Attachments (3)

28885.diff (45.0 KB) - added by DrewAPicture 5 years ago.
28885.1.diff (1.2 KB) - added by michalzuber 5 years ago.
knowledgable typo fix
28885.2.diff (359 bytes) - added by michalzuber 5 years ago.
Duplicate description, removed inline one

Download all attachments as: .zip

Change History (38)

@DrewAPicture
5 years ago

#1 @DrewAPicture
5 years ago

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

#2 @DrewAPicture
5 years ago

In 29139:

Fill out inline documentation for magic methods added to the WP_Text_Diff_Renderer_Table class in [28525].

See #27881, #22234 and #28885.

#3 @DrewAPicture
5 years ago

In 29140:

Fill out inline documentation for magic methods added to the WP_User_Query class in [28528].

See #27881, #22234 and #28885.

#4 @DrewAPicture
5 years ago

In 29141:

Fill out inline documentation for magic methods added to the WP_Query class in [28523].

See #27881, #22234 and #28885.

#5 @DrewAPicture
5 years ago

In 29142:

Fill out inline documentation for magic methods added to the WP_MatchesMapRegex class in [28516].

See #27881, #22234 and #28885.

#6 @DrewAPicture
5 years ago

In 29143:

Fill out inline documentation for magic methods added to the Walker class in [28514].

See #27881, #22234 and #28885.

#7 @DrewAPicture
5 years ago

In 29144:

Fill out inline documentation for magic methods added to the WP_Error class in [28511].

See #27881, #22234 and #28885.

#8 @DrewAPicture
5 years ago

In 29145:

Fill out inline documentation for magic methods added to the WP_Ajax_Response class in [28524].

See #27881, #22234 and #28885.

#9 @DrewAPicture
5 years ago

In 29146:

Fill out inline documentation for magic methods added to the WP_Object_Cache class in [28502], [28521], [28524].

See #27881, #22234 and #28885.

#10 @DrewAPicture
5 years ago

In 29147:

Fill out inline documentation for magic methods added to the WP_Filesystem_Base class in [28521].

See #22234 and #28885.

#11 @DrewAPicture
5 years ago

In 29148:

Fill out inline documentation for magic methods added to the WP_List_Table class in [28493], [28521], and [28524].

See #22234 and #28885.

#12 @DrewAPicture
5 years ago

In 29149:

Fill out inline documentation for magic methods added to the Custom_Background class in [28481], [28521], and [28524].

See #22234 and #28885.

#13 @DrewAPicture
5 years ago

In 29150:

Fill out inline documentation for magic methods added to the Custom_Image_Header class in [28481], [28521], and [28524].

See #22234 and #28885.

#14 @DrewAPicture
5 years ago

In 29151:

Inline documentation cleanup for 4.0 audit.

  • Alignment for the 'term_search_min_chars' hook docs, added in [28892]
  • Globals added for wp_ajax_parse_embed(), added [28580]

See #28885.

#15 @DrewAPicture
5 years ago

In 29152:

Inline documentation for the 'plugin_install_details_link' hook added in [29047] should use a 3-digit, x.x.x-style @since version.

See #28885.

#16 @DrewAPicture
5 years ago

In 29153:

Fill out inline documentation for the __call() magic method added to the WP_Roles class in [28503].

See #22234 and #28885.

#17 @DrewAPicture
5 years ago

In 29154:

Inline documentation cleanup for 4.0 audit.

  • phpDoc tweaks for wp_get_available_translations_from_api(), wp_install_download_language_pack(), and wp_install_load_language(), added in [29018]


See #28885.

#18 @DrewAPicture
5 years ago

In 29155:

Inline documentation cleanup for 4.0 audit.

  • Fill out inline documentation for the __call() magic method added in [28507]
  • Inline documentation tweaks for get_provider(), added in [28728]
  • Inline documentation tweaks for _add_provider_early(), added in [28846]
  • @access tag added for _remove_provider_early(), added in [28846]

See #22234 and #28885.

#19 @DrewAPicture
5 years ago

In 29156:

Inline documentation cleanup for 4.0 audit.

phpDoc tweaks for methods, properties, and filters added in [29051]:

  • WP_Customize_Control->$active_callback property
  • WP_Customize_Control::active() method
  • WP_Customize_Control::active_callback() method
  • WP_Widget_Area_Customize_Control::active_callback() method
  • WP_Widget_Form_Customize_Control::active_callback() method
  • 'customize_control_active' filter

Added in [28930]:

  • WP_Customize_Control::input_attrs() method

See #27993 and #28885.

#20 @DrewAPicture
5 years ago

In 29157:

Inline documentation cleanup for 4.0 audit.

phpDoc tweaks for methods added in [28861]:

  • WP_Customize_Manager::panels() method
  • WP_Customize_Manager::add_panel() method
  • WP_Customize_Manager::get_panel() method
  • WP_Customize_Manager::remove_panel() method

Added in [28970]:

  • WP_Customize_Manager::customize_preview_override_404_status() method

See #27406 and #28885.

#21 @DrewAPicture
5 years ago

In 29158:

Inline documentation cleanup for 4.0 audit.

phpDoc tweaks for methods added in [28861]:

  • WP_Customize_Panel constructor method
  • WP_Customize_Panel::render() method

See #27406 and #28885.

#22 @DrewAPicture
5 years ago

In 29159:

Inline documentation cleanup for 4.0 audit.

phpDoc tweaks for methods, properties, and filters added in [29051]:

  • WP_Customize_Widgets::is_widget_rendered() method
  • WP_Customize_Widgets::is_sidebar_rendered() method

See #27993 and #28885.

#23 @DrewAPicture
5 years ago

In 29160:

Inline documentation cleanup for 4.0 audit.

Document the first parameter, $time, in the 'oembed_ttl' filter, added in [28972].

See #14759 and #28885.

#24 @DrewAPicture
5 years ago

In 29161:

Fill out inline documentation for the __call() magic method added to the wp_xmlrpc_server class in [28515].

See #22234 and #28885.

#25 @DrewAPicture
5 years ago

In 29162:

Fill out inline documentation for the __call() magic method added to the WP_Comment_Query class in [28519].

See #22234 and #28885.

#26 @DrewAPicture
5 years ago

In 29163:

Inline documentation cleanup for 4.0 audit.

Various improvements:

  • Adds @see reference for wp_list_comments() in 'wp_list_comments_args' filter docs, added in [28285]
  • Various phpDoc tweaks for the 'run_wptexturize' filter docs, added in [28715]
  • Sentence and wrapping changes for is_https_url(), added in [28894]
  • Documents the $args parameter for wp_dropdown_languages(), added in [29007]
  • Adds a period to the parameter description for _update_posts_count_on_delete(), added in [28835]
  • Documents a global in is_customize_preview(), added in [28999]
  • phpDoc tweaks, adds an access modifier for wpdb::esc_like(), added in [28711]

See #28885.

#27 @DrewAPicture
5 years ago

In 29164:

Inline documentation cleanup for 4.0 audit.

Added in [28652]:

  • Various phpDoc improvements for wp_embed_handler_youtube()
  • Adds @see reference to wp_embed_handler_youtube() in 'wp_embed_handler_youtube' filter docs

Added in [29029]:

  • s/post_id/post ID in @return description for attachment_url_to_postid()

See #28885.

#28 @DrewAPicture
5 years ago

In 29165:

Add periods to short descriptions for magic methods added in [28501], [28521], and [28524].

See #22234 and #28885.

#29 follow-up: @dnaber-de
5 years ago

While you're cleaning up the inline docs, you may want to have a look at the wrong parameter type specified for a custom Walker in wp_list_comments().

 *     @type string 'walker'            The Walker class used to list comments. Default null.

string is wrong. A correct type definition would be Walker_Comment, but that is only the half of the truth. As long as there is no interface defined, the type should be object with the description of an implemented method paged_walk().

Is it possible to attach another diff-file to this ticket?

#30 in reply to: ↑ 29 @DrewAPicture
5 years ago

Replying to dnaber-de:

While you're cleaning up the inline docs, you may want to have a look at the wrong parameter type specified for a custom Walker in wp_list_comments().

 *     @type string 'walker'            The Walker class used to list comments. Default null.

string is wrong. A correct type definition would be Walker_Comment, but that is only the half of the truth. As long as there is no interface defined, the type should be object with the description of an implemented method paged_walk().

That's a good call. I could probably go for Walker_Comment|object with a note in the description about the object needing to implement a page_walk() method.

Is it possible to attach another diff-file to this ticket?

I'd actually rather you create a separate ticket on the 'docs' focus, as this one is specifically for functionality added in 4.0 :-)

#31 @DrewAPicture
5 years ago

In 29199:

Fix a typo in the @access tag for WP_List_Table::__get().

Props joehoyle.
Fixes #28925. See #28885.

@michalzuber
5 years ago

knowledgable typo fix

@michalzuber
5 years ago

Duplicate description, removed inline one

#32 @SergeyBiryukov
5 years ago

In 29319:

Use 3-digit x.x.x style for two 4.0.0 @since versions.

see #28885.

#33 @DrewAPicture
5 years ago

In 29455:

Clean up some missing @access tags and other tweaks for 4.0.0-functionality docs.

See #28885.

#34 @DrewAPicture
5 years ago

Also, [29454] missed the ticket.

#35 @DrewAPicture
5 years ago

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

We're good here. I'll probably do one last run before we hit RC and reopen if I find anything.

Note: See TracTickets for help on using tickets.