Convert docs for default wp_link_pages() arguments to a hash notation

[DrewAPicture]

Default arguments for wp_link_pages() are already documented in the phpDoc, and they should be converted to the hash-notation style, as ​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 phpDoc for wp_get_archives() in wp-includes/general-template.php.

[taylorde]

Adds hash notation to wp_link_pages docblock

[taylorde]

Also indicate that $echo, while it defaults to an integer, is evaluating a truthy condition and could, therefore, be expressed as a boolean.

[DrewAPicture]

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.

[taylorde]

Documentation patch revision based on feedback. Adjusts language.

[taylorde]

Thanks for the feedback,
I've uploaded another patch that hopefully reflects what you're looking for a bit closer.

[taylorde]

Upload the correct patch this time...

[DrewAPicture]

28680.3.patch​ looks great. Thanks!

[DrewAPicture]

In 28899:

Re-document default arguments in wp_link_pages() using the hash-notation style.

Props taylorde.
Fixes #28680.