WordPress.org

Make WordPress Core

Opened 2 weeks ago

Last modified 3 days 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 (3)

48348.patch (5.9 KB) - added by Marcio Zebedeu 12 days ago.
adding documentation > Ticket #48348
48348.1.patch (6.1 KB) - added by Marcio Zebedeu 11 days ago.
adding documentation > Ticket #48348
48417.patch (2.4 KB) - added by Marcio Zebedeu 7 days ago.
made the change from wordpress to WordPress

Download all attachments as: .zip

Change History (21)

#1 @marekdedic
2 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 11 days ago by SergeyBiryukov (previous) (diff)

#2 @marekdedic
2 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 2 weeks ago by marekdedic (previous) (diff)

#3 @marekdedic
2 weeks ago

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

@Marcio Zebedeu
12 days ago

adding documentation > Ticket #48348

@Marcio Zebedeu
11 days ago

adding documentation > Ticket #48348

@Marcio Zebedeu
7 days ago

made the change from wordpress to WordPress

#4 @SergeyBiryukov
6 days ago

In 46591:

Docs: Improve formatting of various WP_Screen DocBlocks.

See #48303.

#5 @johnbillion
5 days ago

In 46594:

Docs: Miscellaneous docblock fixes and improvements.

See #48303

#6 @johnbillion
5 days ago

In 46595:

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

Props marekdedic

See #48303

#7 @johnbillion
5 days ago

In 46596:

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

See #48303, #41756

#8 @johnbillion
5 days ago

In 46597:

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

See #48303

#9 @johnbillion
5 days ago

In 46598:

Docs: Add missing docs for the auth_cookie_bad_session_token action.

See #48303

#10 @johnbillion
5 days ago

In 46599:

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

See #48303

#11 @SergeyBiryukov
4 days ago

In 46600:

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

See #48303.

#12 @johnbillion
4 days ago

In 46603:

Docs: Correct invalid hook docblocks.

See #48303

#13 @johnbillion
4 days ago

In 46604:

Docs: Correct invalid hook docblock placement.

See #48303

#14 @SergeyBiryukov
3 days 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.


3 days ago

#16 @johnbillion
3 days ago

In 46608:

Docs: Remove some funky nested filters.

See #48303

#17 @johnbillion
3 days ago

In 46609:

Docs: Coding standards fix after [46608].

See #48303

#18 @johnbillion
3 days ago

In 46610:

Docs: Miscellaneous docblock corrections.

See #48303

Note: See TracTickets for help on using tickets.