WordPress.org

Make WordPress Core

Opened 8 weeks ago

Last modified 10 hours ago

#48303 new task (blessed)

Docblock improvements for 5.4

Reported by: desrosj Owned by:
Milestone: 5.4 Priority: normal
Severity: normal Version:
Component: General Keywords:
Focuses: docs Cc:
PR Number:

Description

Previously:

Attachments (6)

48348.patch (5.9 KB) - added by Marcio Zebedeu 7 weeks ago.
adding documentation > Ticket #48348
48348.1.patch (6.1 KB) - added by Marcio Zebedeu 7 weeks ago.
adding documentation > Ticket #48348
48417.patch (2.4 KB) - added by Marcio Zebedeu 6 weeks ago.
made the change from wordpress to WordPress
48352.patch (789 bytes) - added by spenserhale 5 weeks ago.
46644.patch (1.1 KB) - added by Marcio Zebedeu 5 weeks ago.
Corrected array hash notations
46691.patch (1.5 KB) - added by Marcio Zebedeu 4 weeks ago.
Docs: Moved the @link tag for Customize API in WP_Customize_Manager::add_setting() and WP_Customize_Setting

Download all attachments as: .zip

Change History (48)

#1 @marekdedic
7 weeks ago

I didn't know about this tracking ticket for all the small docs issues, so I created a lot of small ones (sorry...)

#48343
$args documentation for WP_Customize_Control::__construct() and WP_Customize_Manager::add_control() don't match
#48344
WP_Customize_Panel::__construct() is missing `$args` documentation
#48346
WP_Customize_Section::__construct() is missing `$args` documentation
#48347
WP_Customize_Setting::__construct() is missing `$args` documentation
#48348
WP_Customize_Color_Control::__construct should link to parent constructor for $args
#48349
Requests::request_multiple() should have the option documentation in phpDoc
#48350
Stricter docs for WP_Http::processHeaders()
#48351
Stricter docs for WP_Http::processResponse()
#48352
Stricter docs for deactivate_plugins
#48353
Stricter docs for esc_url
#48354
Stricter docs for is_page() and WP_Query::is_page()


Last edited 7 weeks ago by SergeyBiryukov (previous) (diff)

#2 @marekdedic
7 weeks ago

wp_enqueue_script, wp_enqueue_style, wp_register_script and wp_register_style parameter $deps could be narrowed from array to string[].

Last edited 7 weeks ago by marekdedic (previous) (diff)

#3 @marekdedic
7 weeks ago

wp_unslash parameter and return value could be narrowed from string|array to string|string[].

@Marcio Zebedeu
7 weeks ago

adding documentation > Ticket #48348

@Marcio Zebedeu
7 weeks ago

adding documentation > Ticket #48348

@Marcio Zebedeu
6 weeks ago

made the change from wordpress to WordPress

#4 @SergeyBiryukov
6 weeks ago

In 46591:

Docs: Improve formatting of various WP_Screen DocBlocks.

See #48303.

#5 @johnbillion
6 weeks ago

In 46594:

Docs: Miscellaneous docblock fixes and improvements.

See #48303

#6 @johnbillion
6 weeks ago

In 46595:

Docs: Switch to typed array notation for the docs for asset dependency functions.

Props marekdedic

See #48303

#7 @johnbillion
6 weeks ago

In 46596:

Docs: Switch more docs over to typed array notation, plus some fixes.

See #48303, #41756

#8 @johnbillion
6 weeks ago

In 46597:

Docs: Update the docs for the error parameter that gets passed around during filesystem credential collection.

See #48303

#9 @johnbillion
6 weeks ago

In 46598:

Docs: Add missing docs for the auth_cookie_bad_session_token action.

See #48303

#10 @johnbillion
6 weeks ago

In 46599:

Docs: Correct and improve inline docs for the file type functions.

See #48303

#11 @SergeyBiryukov
6 weeks ago

In 46600:

Docs: Improve DocBlock formatting in WP_Block_Styles_Registry per the documentation standards.

See #48303.

#12 @johnbillion
6 weeks ago

In 46603:

Docs: Correct invalid hook docblocks.

See #48303

#13 @johnbillion
6 weeks ago

In 46604:

Docs: Correct invalid hook docblock placement.

See #48303

#14 @SergeyBiryukov
6 weeks ago

In 46607:

Docs: Restore correct placement for duplicate hook reference in render_block_core_latest_comments().

Previously fixed in [46604], accidentally reverted in [46606].

See #48447, #48303.

This ticket was mentioned in Slack in #docs by atachibana. View the logs.


6 weeks ago

#16 @johnbillion
6 weeks ago

In 46608:

Docs: Remove some funky nested filters.

See #48303

#17 @johnbillion
6 weeks ago

In 46609:

Docs: Coding standards fix after [46608].

See #48303

#18 @johnbillion
6 weeks ago

In 46610:

Docs: Miscellaneous docblock corrections.

See #48303

#19 @johnbillion
5 weeks ago

In 46623:

Docs: Correct some incorrect docblock tags.

See #48303

#21 @SergeyBiryukov
5 weeks ago

In 46630:

Docs: Correct @see references for PHP 4 constructors in wp-includes/class-json.php.

See #48252, #48303.

@spenserhale
5 weeks ago

#22 @spenserhale
5 weeks ago

Attached patch for #48352

#23 follow-up: @johnbillion
5 weeks ago

In 46644:

Docs: Fix some incorrect return tags in docblocks.

See #48303

#24 in reply to: ↑ 23 @Marcio Zebedeu
5 weeks ago

Replying to johnbillion:

In 46644:

Docs: Fix some incorrect return tags in docblocks.

See #48303

I'll fix it.

#25 follow-up: @SergeyBiryukov
5 weeks ago

In 46647:

Docs: Correct some array hash notations added in [46644].

See #48303.

@Marcio Zebedeu
5 weeks ago

Corrected array hash notations

#26 in reply to: ↑ 25 ; follow-up: @Marcio Zebedeu
5 weeks ago

Replying to SergeyBiryukov:

In 46647:

Docs: Correct some array hash notations added in [46644].

See #48303.

Can you please confirm? I had my doubts about naming patch.

#27 @johnbillion
5 weeks ago

In 46652:

Docs: Correct and improve the readability of some parameters of WP_Term_Query.

See #48303

#28 @johnbillion
4 weeks ago

In 46660:

Docs: Improve documentation of known return types, plus other docs fixes.

See #48303

#29 @johnbillion
4 weeks ago

In 46661:

Docs: Further improve documentation of known return types, plus other docs fixes.

See #48303

#30 @johnbillion
4 weeks ago

In 46662:

Docs: Docs on docs. Further improve documentation of known return types, plus other docs fixes.

See #48303

#31 follow-up: @SergeyBiryukov
4 weeks ago

In 46691:

Docs: Move the @link tag for Customize API in WP_Customize_Manager::add_setting() and WP_Customize_Setting to a more appropriate place.

See #48303.

@Marcio Zebedeu
4 weeks ago

Docs: Moved the @link tag for Customize API in WP_Customize_Manager::add_setting() and WP_Customize_Setting

#32 in reply to: ↑ 31 @Marcio Zebedeu
4 weeks ago

Replying to SergeyBiryukov:

In 46691:

Docs: Move the @link tag for Customize API in WP_Customize_Manager::add_setting() and WP_Customize_Setting to a more appropriate place.

See #48303.

done

#33 in reply to: ↑ 26 ; follow-up: @SergeyBiryukov
4 weeks ago

Replying to Marcio Zebedeu:

Can you please confirm? I had my doubts about naming patch.

Thanks for the patches! However, [46647] and [46691] are changesets, not tasks. These are changes that are already committed and generally don't require additional patches, unless you notice a typo or any other inaccuracy :)

#34 in reply to: ↑ 33 @Marcio Zebedeu
4 weeks ago

Replying to SergeyBiryukov:

Replying to Marcio Zebedeu:

Can you please confirm? I had my doubts about naming patch.

Thanks for the patches! However, [46647] and [46691] are changesets, not tasks. These are changes that are already committed and generally don't require additional patches, unless you notice a typo or any other inaccuracy :)

Oh...thank. I'm still learning :)

#35 @SergeyBiryukov
4 weeks ago

In 46695:

Docs: Miscellaneous docblock corrections in wp-admin/includes/plugin.php.

See #48303.

#36 @SergeyBiryukov
4 weeks ago

In 46696:

Docs: In various @return tags, list the expected type first, instead of WP_Error.

See #48303.

#37 @johnbillion
3 weeks ago

In 46729:

Docs: Correct some invalid hook docblocks.

See #48303

#38 @SergeyBiryukov
2 weeks ago

In 46760:

Docs: Adjust wp_is_json_request() and wp_is_xml_request() return value descriptions for consistency.

See #48771, #48303.

#39 @SergeyBiryukov
8 days ago

In 46800:

Docs: Replace @returns tags in JS docs with @return.

Per the documentation standards, @returns is an unsupported synonym, @return should be used instead:
https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/

See #48303.

#40 @SergeyBiryukov
7 days ago

In 46801:

Docs: Correct @param type for the function parameter in tests_add_filter() and _test_filter_build_unique_id().

Synchronize documentation for add_filter(), tests_add_filter(), _wp_filter_build_unique_id(), _test_filter_build_unique_id().

Add a note that $tag and $priority are no longer used in _wp_filter_build_unique_id() since [46220], and the function always returns a string now.

Props donmhico, remcotolsma, SergeyBiryukov.
Fixes #47407. See #48303.

#41 @johnbillion
10 hours ago

In 46821:

Docs: Correct various docblocks documentation.

See #48303

#42 @johnbillion
10 hours ago

In 46823:

Docs: Increase the specificity of various docblock parameter types and return types.

See #48303

Note: See TracTickets for help on using tickets.