[wp-trac] [WordPress Trac] #30483: Improve inline documentation in wp-admin/includes/ms.php

[WordPress Trac]

#30483: Improve inline documentation in wp-admin/includes/ms.php
--------------------------------+------------------------------
 Reporter:  dustyf              |       Owner:
     Type:  defect (bug)        |      Status:  new
 Priority:  normal              |   Milestone:  Future Release
Component:  Networks and Sites  |     Version:
 Severity:  normal              |  Resolution:
 Keywords:  has-patch           |     Focuses:  docs, multisite
--------------------------------+------------------------------
Changes (by DrewAPicture):

 * version:  trunk =>


Comment:

 Hi Dusty, thanks for the patches. I've made some adjustments in
 [attachment:30483.4.diff], namely:

 * Line-wrapping at ~80 characters whenever possible
 * Some functions had optional parameters that weren't documented as such
 in the new DocBlocks
 * The syntax for `@global` tags is `@global type $variable Description.`
 * In descriptions other than the summary (formerly 'short description'),
 any inline code should be backtick-escaped and function/hook/class/method
 references linked with inline `@see` tags. See the
 [https://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#other-descriptions Other Descriptions]
 section of the standard for more on those tags

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