[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:  DrewAPicture
     Type:  defect (bug)                |      Status:  reviewing
 Priority:  normal                      |   Milestone:  4.0
Component:  Posts, Post Types           |     Version:
 Severity:  normal                      |  Resolution:
 Keywords:  good-first-bug needs-patch  |     Focuses:  docs
----------------------------------------+---------------------------
Changes (by DrewAPicture):

 * keywords:  good-first-bug has-patch => good-first-bug needs-patch


Comment:

 Hi, thanks for the patch.

 Some notes:

 * On the `$echo` parameter, you can just use `int|bool` type (core style)
 * Anywhere possible, we try to reduce the use of "The" at the beginning of
 parameter descriptions. Just gets a little repetitive
 * All parameter descriptions should end with a period.
 * "To each bookmarks" is nonsensical
 * "Default is ''" can just be "Default empty" (except for the one that has
 an empty space in it.
 * Core style on values expected as int|bool, we notate that in the
 description as both just for clarity. So 1 would be 1|true, 0|false.

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