[wp-trac] [WordPress Trac] #28680: Convert docs for default wp_link_pages() arguments to a hash notation

[WordPress Trac]

#28680: Convert docs for default wp_link_pages() arguments to a hash notation
-------------------------------+----------------------------------------
 Reporter:  DrewAPicture       |      Owner:
     Type:  defect (bug)       |     Status:  new
 Priority:  normal             |  Milestone:  Awaiting Review
Component:  Posts, Post Types  |    Version:
 Severity:  normal             |   Keywords:  needs-patch good-first-bug
  Focuses:  docs               |
-------------------------------+----------------------------------------
 Default arguments for `wp_link_pages()` are already documented in the
 phpDoc, and they should be converted to the hash-notation style, as
 [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#1-1-parameters-that-are-arrays outlined in
 the inline docs standards].

 Current Reference:
 http://developer.wordpress.org/reference/functions/wp_link_pages/

 A good example of documenting arguments arrays is the
 [https://core.trac.wordpress.org/browser/trunk/src/wp-includes/general-
 template.php#L1156 phpDoc] for `wp_get_archives()` in wp-includes/general-
 template.php.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/28680>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform