WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

Last modified 5 years ago

#30469 closed task (blessed) (fixed)

Inline Docs audit for 4.1

Reported by: DrewAPicture Owned by: DrewAPicture
Milestone: 4.1 Priority: normal
Severity: normal Version:
Component: General Keywords:
Focuses: docs Cc:

Description


Attachments (1)

30469.diff (12.3 KB) - added by ericlewis 6 years ago.

Download all attachments as: .zip

Change History (34)

#1 @DrewAPicture
6 years ago

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

#2 @DrewAPicture
6 years ago

[30595] fixed the DocBlock and added some inline comments to wp_ajax_destroy_sessions().

#3 @DrewAPicture
6 years ago

In 30599:

4.1 Docs Audit: Clarify the DocBlock summary for the edit_form_before_permalink hook.

See #30469.

#4 @DrewAPicture
6 years ago

In 30600:

4.1 Docs Audit: Convert a hook reference to an inline @see tag in the hook docs for the image_add_caption_text filter.

See #30469.

#5 @DrewAPicture
6 years ago

In 30601:

4.1 Docs Audit: Fix a variety of issues with the DocBlock for the default_page_template_title filter.

Includes hyphenating 'drop-down', ensuring the DocBlock itself is correctly indented, and wraps lines at an appropriate length.

See #30469.

#6 @DrewAPicture
6 years ago

In 30602:

4.1 Docs Audit: Document the $post global in the DocBlock for wp_print_revision_templates().

See #30469.

#7 @DrewAPicture
6 years ago

In 30603:

4.1 Docs Audit: Clarify the DocBlock summary for network_settings_add_js() to specify that it's specific to the Network Settings screen.

See #30469.

#8 @DrewAPicture
6 years ago

In 30604:

4.1 Docs Audit: Fix some line-wrapping in the DocBlock for WP_Http::parse_url().

See #30469.

#9 @DrewAPicture
6 years ago

In 30605:

4.1 Docs Audit: Improve inline documentation for various properties and methods in the WP_Customize_Control and WP_Customize_Upload_Control classes.

See #30469.

#10 @DrewAPicture
6 years ago

In 30606:

4.1 Docs Audit: Improve inline documentation for various properties and methods in the WP_Customize_Manager class.

See #30469.

#11 @DrewAPicture
6 years ago

In 30607:

4.1 Docs Audit: Improve inline documentation for various properties and methods in the WP_Customize_Panel class.

See #30469.

#12 @DrewAPicture
6 years ago

In 30608:

4.1 Docs Audit: Improve inline documentation for various properties and methods in the WP_Customize_Section, WP_Customize_Section, and WP_Customize_Sidebar_Section classes.

See #30469.

#13 @DrewAPicture
6 years ago

In 30609:

4.1 Docs Audit: Fix DocBlock formatting for the customize_preview_{$this->type} hook.

See #30469.

#14 @DrewAPicture
6 years ago

In 30610:

4.1 Docs Audit: Various formatting fixes for inline documentation in class-wp-list-table.php and comment-template.php.

See #30469.

#15 @DrewAPicture
6 years ago

In 30611:

4.1 Docs Audit: Improve inline documentation in various WP_Date_Query methods modified in 4.1.

See #30469.

#16 @DrewAPicture
6 years ago

In 30612:

Ensure only spaces are used instead of a mixture of tabs and spaces for alignment within the DocBlock for the date_query_valid_columns hook. See [30611].

See #30469.

#17 @DrewAPicture
6 years ago

In 30613:

4.1 Docs Audit: Ensure optional arguments in wp_json_encode() are properly documented as such.

See #30469.

#18 @DrewAPicture
6 years ago

In 30614:

Improve line-wrapping and formatting in the DocBlock for wp_send_json_error().

See #30469.

#19 @DrewAPicture
6 years ago

In 30615:

Ensure the private function _wp_render_title_tag() is marked for internal usage only.

See #30469.

#20 @DrewAPicture
6 years ago

In 30616:

4.1 Docs Audit: Ensure optional arguments in get_the_post_navigation(), the_post_navigation(), get_the_posts_navigation(), the_posts_navigation(), get_the_pagination(), and the_pagination() are properly documented with defaults.

See #30469.

#21 @DrewAPicture
6 years ago

In 30617:

4.1 Docs Audit: Improve inline documentation for various WP_Meta_Query methods introduced or modified in 4.1.

See #30469.

#22 @DrewAPicture
6 years ago

In 30618:

4.1 Docs Audit: Spell out HTML element names in DocBlock summaries for the nav_menu_css_class, nav_menu_item_id, and nav_menu_link_attributes filters.

Due to a recent clarification in the core inline documentation standards, HTML tags are no longer allowed in DocBlock summaries as they wreak havoc on displaying pages in the official Code Reference. See #30473.

See #30469.

#23 @DrewAPicture
6 years ago

In 30619:

4.1 Docs Audit: Formatting, line-wrap, and other fixes for the wp_get_nav_menus() DocBlock.

See #30469.

#24 @DrewAPicture
6 years ago

In 30620:

4.1 Docs Audit: Improve inline documentation for the new WP_Query::setup_postdata() method.

See #30469.

#25 @DrewAPicture
6 years ago

In 30621:

4.1 Docs Audit: Remove a duplicate word from a parameter description in the DocBlock for the wp_save_post_revision_post_has_changed hook.

See #30469.

#26 @DrewAPicture
6 years ago

In 30622:

4.1 Docs Audit: Improve inline documentation in DocBlocks for various WP_Tax_Query methods, the pre_delete_term hook, and get_ancestors().

See #30469.

#27 @DrewAPicture
6 years ago

In 30623:

4.1 Docs Audit: Fix formatting for changelog entries in count_user_posts() and the get_usernumposts hook.

See #30469.

@ericlewis
6 years ago

#28 @ericlewis
6 years ago

attachment:30469.diff includes @since tags, function summaries and @param tags.

#29 @DrewAPicture
6 years ago

  • Owner changed from DrewAPicture to wonderboymusic
  • Status changed from accepted to assigned

@wonderboymusic: Could you please review and commit Eric's patch for 4.1 JS docs?

#30 @wonderboymusic
6 years ago

In 30738:

Add some inline JS docs for Customizer.

See #30469.

#31 @wonderboymusic
6 years ago

  • Owner changed from wonderboymusic to DrewAPicture

#32 @DrewAPicture
6 years ago

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

This ticket was mentioned in Slack in #bbpress by netweb. View the logs.


5 years ago

Note: See TracTickets for help on using tickets.