WordPress.org

Make WordPress Core

Opened 3 months ago

Last modified 4 days ago

#50768 new task (blessed)

Docblock improvements for 5.6

Reported by: SergeyBiryukov Owned by:
Milestone: 5.6 Priority: normal
Severity: normal Version:
Component: General Keywords:
Focuses: docs Cc:

Description

Previously:

Change History (33)

#1 @SergeyBiryukov
3 months ago

In 48694:

Docs: Correct formatting for a comment in wp-admin/options-permalink.php.

See #50768.

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


3 months ago

#3 @SergeyBiryukov
3 months ago

In 48711:

Docs: Correct formatting for a comment in wp-admin/options-permalink.php.

Previously committed in [48694], accidentally reverted in [48710].

See #50768.

#4 @SergeyBiryukov
3 months ago

In 48714:

Docs: Correct placement for wp_editor_expand filter DocBlock.

See #50768.

#5 @SergeyBiryukov
3 months ago

In 48782:

Docs: Consistently use third-person singular verbs for various filter descriptions, per the documentation standards.

See #50768.

#6 @SergeyBiryukov
3 months ago

In 48793:

Docs: Document the parameters of wp_get_associated_nav_menu_items() as optional.

See #50768.

#7 @SergeyBiryukov
2 months ago

In 48816:

Docs: Correct alignment for some DocBlocks in WP_Query::get_posts().

See #50768.

#8 @SergeyBiryukov
2 months ago

In 48855:

Docs: Improve documentation for wp_lazy_loading_enabled() per the documentation standards.

See #50768.

#9 @SergeyBiryukov
2 months ago

In 48903:

Docs: Correct formatting of the auto_theme_update_send_email filter DocBlock.

Synchronize description of the $enabled parameter with the auto_plugin_update_send_email filter.

Follow-up to [48889].

See #50768, #50988.

#10 @SergeyBiryukov
2 months ago

In 48929:

Docs: Synchronize the description of the $format parameter in various date/time functions for posts and comments.

See #50768.

#11 @johnbillion
8 weeks ago

In 48941:

Docs: Various docblock corrections and improvements.

See #50768

#12 @SergeyBiryukov
8 weeks ago

In 48942:

Docs: Further correct placement for wp_editor_expand filter DocBlock.

This ensures that the filter is only applied if the conditions before it are evaluated to true.

Follow-up to [48714].

Props johnbillion.
See #50768.

#13 @desrosj
7 weeks ago

In 48962:

Docs: Improve the recovery_mode_email inline docs.

See #51267, #50768.

#14 @SergeyBiryukov
6 weeks ago

In 48984:

Docs: Correct the parameter type for networks_pre_query filter.

The filter should return the network count as an integer if $this->query_vars['count'] is set.

Follow-up to [46100].

See #50768, #47599.

#15 @SergeyBiryukov
6 weeks ago

In 48985:

Docs: Fix typo in *_pre_query filter DocBlocks.

See #50768.

#16 @SergeyBiryukov
6 weeks ago

In 48986:

Docs: Reformat comments_pre_query, networks_pre_query, sites_pre_query DocBlocks for better readability.

See #50768.

#17 @SergeyBiryukov
6 weeks ago

In 48987:

Docs: Correct comments in comments_pre_query, networks_pre_query, and sites_pre_query tests.

Follow-up to [44983], [46086].

See #50768.

#18 @johnbillion
6 weeks ago

In 49016:

Media: Correct some types in docblocks for filters related to thumbnails.

Props dilipbheda

See #47364, #50768

#19 @johnbillion
6 weeks ago

In 49017:

Media: Correct some types for attachment ID parameters passed to functions and filters.

See #47364, #50768

#20 @johnbillion
6 weeks ago

In 49020:

Docs: Inline documentation improvements for media related functions and hooks.

See #47364, #50768

#21 @johnbillion
6 weeks ago

In 49028:

Docs: Correct the indentation for some array type docs.

See #50768

#22 @SergeyBiryukov
5 weeks ago

In 49066:

Docs: Clarify the false return value of get_post_type_archive_link() and get_post_type_archive_feed_link().

See #50768.

#23 @johnbillion
4 weeks ago

In 49078:

Docs: Various docblock improvements related to user and site signup functionality.

See #50768

#24 @SergeyBiryukov
4 weeks ago

In 49095:

Docs: Synchronize descriptions of some query functions and their counterpart methods in WP and WP_Query classes:

  • set_query_var()
  • get_query_var()
  • get_queried_object()
  • get_queried_object_id()

Switch to third-person singular verbs, per the documentation standards.

See #50768, #42783.

#25 @SergeyBiryukov
3 weeks ago

In 49106:

Twenty Ten: Docs: Fix typo in twentyten_custom_excerpt_more() DocBlock.

Update @return tag for twentyten_auto_excerpt_more() for consistency with Twenty Eleven.

See #51477, #50768.

#26 @johnbillion
3 weeks ago

In 49119:

Docs: Fix the types for some properties and parameters that use the generic object type.

See #50768

#27 @johnbillion
2 weeks ago

In 49181:

Docs: Miscellaneous docblock fixes.

See #50768

#28 @johnbillion
2 weeks ago

In 49183:

Docs: Fix and upgrade various object docblock notations.

See #50768

#29 @johnbillion
12 days ago

In 49196:

Docs: Improve the docs for the globals that are used in the actions and filters API.

See #50531, #50768

#30 @johnbillion
12 days ago

In 49197:

Docs: Further corrections and promotions for docblocks relating to object types.

See #50768

#31 @SergeyBiryukov
11 days ago

In 49233:

Docs: Use 3-digit, x.x.x style semantic versioning for @since 5.6.0 entries in WP_Image_Editor_Imagick.

See #50768.

#32 @SergeyBiryukov
4 days ago

In 49311:

Docs: Add missing @since tags for properties in some block editor classes:

  • WP_Block_Pattern_Categories_Registry
  • WP_Block_Patterns_Registry
  • WP_Block_Supports

Follow-up to [48156], [49226].

See #50768.

#33 @SergeyBiryukov
4 days ago

In 49326:

Docs: Fix typo in {$old_status}_to_{$new_status} hook description.

See #50768.

Note: See TracTickets for help on using tickets.